AddOns

post/v1/add-ons

Request

  • Base URL: https://api.tokenbooks.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.tokenbooks.io/v1/add-ons
  • Auth: API key in header x-api-key

Request body

idstring required

Add-on catalog ID

displayNamestring required

Add-on display name

descriptionstring required

Add-on description

category'MODULE' | 'CAPACITY' | 'SERVICE' required

Add-on commercial category

eligiblePlanIdsstring[]

Subscription plan IDs allowed to purchase this add-on

stripeProductIdstring required

Stripe product ID

monthlyPriceIdstring nullable

Stripe price ID for monthly billing

annualPriceIdstring nullable

Stripe price ID for annual billing

oneTimePriceIdstring nullable

Stripe price ID for one-time billing

featureIdsGrantedstring[]

Feature IDs this add-on grants while it stays active

limitTransactionsDeltainteger

Transaction limit increase per purchased unit

limitUsersDeltainteger

User limit increase per purchased unit

limitPortfoliosDeltainteger

Portfolio limit increase per purchased unit

limitWalletsDeltainteger

Wallet limit increase per purchased unit

maxQuantityinteger nullable

Highest quantity one workspace may hold; null when unbounded

salesApprovedboolean

Whether self-serve purchase is blocked and sales approval is required

Response

idstring required

Add-on catalog ID

displayNamestring required

Add-on display name

descriptionstring required

Add-on description

category'MODULE' | 'CAPACITY' | 'SERVICE' required

Add-on commercial category

eligiblePlanIdsstring[] required

Subscription plan IDs allowed to purchase this add-on

stripeProductIdstring required

Stripe product ID

monthlyPriceIdstring nullable required

Stripe price ID for monthly billing

annualPriceIdstring nullable required

Stripe price ID for annual billing

oneTimePriceIdstring nullable required

Stripe price ID for one-time billing

featureIdsGrantedstring[] required

Feature IDs this add-on grants while it stays active

limitTransactionsDeltainteger required

Transaction limit increase per purchased unit

limitUsersDeltainteger required

User limit increase per purchased unit

limitPortfoliosDeltainteger required

Portfolio limit increase per purchased unit

limitWalletsDeltainteger required

Wallet limit increase per purchased unit

maxQuantityinteger nullable required

Highest quantity one workspace may hold; null when unbounded

salesApprovedboolean required

Whether self-serve purchase is blocked and sales approval is required

createdAtstring date-time required

Creation timestamp (ISO 8601)

updatedAtstring date-time required

Last update timestamp (ISO 8601)

Changes

No recorded changes to this operation across all 1 revision of this API.