Skip to navigation

Create a plan

View as Markdown
Create a subscription plan.

Authentication

x-api-keystring

Account API key used to authenticate server-side requests. Use the credentials issued for the same environment as the API base URL.

Headers

Idempotency-KeystringOptional<=255 characters

Unique key used to safely retry the same state-changing request.

Request

This endpoint expects an object.
namestringRequired<=255 characters
amountdoubleRequired
currencystringRequired
billing_intervalenumRequired
Allowed values:
descriptionstringOptional<=2000 characters
featureslist of stringsOptional

Response

Subscription plan created successfully.
messagestring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error