FieldDescription
nameString: The public name of the product. This will be displayed everywhere that is user facing.
descriptionString: The description of the product. This is an opportunity to explain your features and the specific details of how your users' lives will be improved using your product.
Bool: Flag for if the product has access to all your endpoints. This exists because certain products may not have access to premium endpoints.
has_quotaBool: Flag for if the product has a quota. If False, users subscribed to this product essentially have unlimited API calls to your backend barring rate limits.
has_trialBool: Flag for if the product has a quota. If False, users subscribed to this product essentially have unlimited API calls to your backend barring rate limits.
is_freeBool: Flag for if the product is free.
periodEnum for the billing cycle or how often subscribers get charged.
Options are month or year. Check out Products for more details.
priceDouble: The price in USD of the product for each period. Currently all products are subscription based.
quotaint: The amount of API calls subscribers get per month. If has_quota is false this field is ignored.
tier_idString: The id of the product. This is important for you to create checkout sessions and in the next step of pricing integration.
trial_lengthint: The number of trial_time_frame the trial lasts. If has_trial is false this field is ignored.
trial_time_frameEnum:

The number of trial_time_frame the trial lasts. If has_trial is false this field is ignored.

Options are day, week and month.
Language
Authentication
Header
Click Try It! to start a request and see the response here!