SubscriptionPlans

patch/v1/subscription-plans/{id}

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/subscription-plans/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Subscription plan ID

Request body

namestring

Subscription plan name

stripeProductIdstring

Stripe product ID

featuresobject

Legacy feature configuration

featureIdsstring[]

Enabled feature IDs

limitTransactionsinteger

Transaction limit

limitUsersinteger

User limit

limitPortfoliosinteger

Portfolio limit

limitWalletsinteger

Wallet limit

isAutoUpdateEnabledboolean

Whether auto-update is enabled

isPublicboolean

Whether the plan is offered publicly on pricing and /subscribe

canUpgradeboolean

Whether workspaces on this plan are shown an upgrade path

Response

idstring required

Subscription plan ID

namestring required

Subscription plan name

stripeProductIdstring required

Stripe product ID

featuresobject required

Legacy feature configuration

featureIdsstring[] required

Enabled feature IDs

limitTransactionsinteger required

Transaction limit

limitUsersinteger required

User limit

limitPortfoliosinteger required

Portfolio limit

limitWalletsinteger required

Wallet limit

isAutoUpdateEnabledboolean required

Whether auto-update is enabled

isPublicboolean required

Whether the plan is offered publicly on pricing and /subscribe

canUpgradeboolean required

Whether workspaces on this plan are shown an upgrade path

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.