Skip to navigation

Create a subscription

View as Markdown
Start a subscription on a 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.
subscription_plan_idstringRequired
payment_methodenumRequired
Recurring charges settle over MPP.
Allowed values:
subscriber_idstringOptional
Agent or user id that subscribed.
subscriber_typeenumOptionalDefaults to agent
Allowed values:

Response

Subscription 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