List Products

Returns all active products from Stripe that are available in the geo location of the customer. If desired, a set of IDs can be passed as a query parameter to return only those specific products.

Key Fields:

  • name - The product name, for display to customers
  • description - Extra information about the product e.g. ‘Season pass for all games’
  • marketingFeatures - This is an array of extra information strings that you can display to the customer, letting them know what features this product grants e.g. ‘Presale ticket access’, ‘Eclusive interviews’ etc.
  • prices/defaultPrice - These are the available prices for your product, and will also be automatically filtered by geo location. To create a checkout session, you make a call to create-checkout-session using the ID of the price you wish to charge the user. Prices will either be of type ‘one_time’ or ‘recurring’ and will contain information about their billing and how long they give access. Currencies will also be served according to the customer's geo location if this has been set up with us by your account manager.
  • features - Not to be confused with marketingFeatures! These features specify what entitlements are granted to the customer when they purchase this product. e.g., if the Paid Access feature is attached to this product, a customer will get Paid Access for the duration they are paying for this product. Similarly, if instead, the feature is for a PPV event, e.g. Liverpool V Man Utd Match Pass, they will gain access to just that entitlement instead. The featureId of these features, can be compared against the user subscription response to check if a customer already has access to a feature granted by the product, so you can prevent them accidentally buying the same thing twice, for example.

Header Parameters

cloudfront-viewer-countrystring

Country code for product and price geo restrictions

X-API-Keystring

Query Parameters

idsstring

Comma-separated list of product IDs to filter the results. If provided, only products with matching IDs will be returned. Invalid or missing IDs will be silently ignored.

Response

200
Object
List of products

Response Attributes

productsarray

Show child attributes

400
Object
Bad Request/Validation Error - Typically an issue with the request parameters or context

Response Attributes

codestring

Error code identifying the type of error

Enum values:
BAD_REQUESTUNAUTHORIZEDFORBIDDENNOT_FOUNDINTERNAL_SERVER_ERRORINCORRECT_DATANOT_MEMBERALREADY_MEMBERINCORRECT_STRIPE_SIGNATUREINCORRECT_STRIPE_EVENT
... 5 other enums
messagestring

Human-readable error message

detailsarray
401
Object
Unauthorized - Invalid API key

Response Attributes

messagestring

Error message

codestring

Error code

detailsobject

Additional error details

500
Object
Server error - check errors field for specific error type

Response Attributes

errorsstring Required

Error code identifying the type of error

Enum values:
bad_requestunauthorizedforbiddennot_found500incorrect_datanot_memberalready_memberincorrect_stripe_signatureincorrect_stripe_event
... 4 other enums
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?