Products

What products are and how they work

Products are essentially subscription objects that you can create, modify or delete on our site or with our REST API.

Product Specs

Field

Description

name

String: The public name of the product. This will be displayed everywhere that is user facing.

description

String: 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.

has_full_access

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_quota

Bool: 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_trial

Bool: 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_free

Bool: Flag for if the product is free.

period

Enum for the billing cycle or how often subscribers get charged.
Options are month or year. Check out Products for more details.

price

Double: The price in USD of the product for each period. Currently all products are subscription based.

quota

int: The amount of API calls subscribers get per month. If has_quota is false this field is ignored.

tier_id

String: The id of the product. This is important for you to create checkout sessions and in the next step of pricing integration.

trial_length

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

trial_time_frame

Enum:

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

Options are day, week and month.

❗️

Modified Product Prices Are not retroactive.

Whenever you change the price of a product, users who have already been subscribed will continue to pay the previous price you had set for them.

🚧

Deleted Products Are Never Truly Deleted

Whenever you delete a product, if there are existing users, they will still maintain that product.

More details coming soon.


Did this page help you?