v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Create Plan

Creates a reusable pricing plan. Plans are immutable once created — a price change means creating a new plan; existing subscriptions on the old plan are unaffected.

post/plans

Request body

namestring required

The plan name (MAX 255; MIN 3).

descriptionstring

The plan description. No length limit is currently enforced.

merchant_referencestring

Your own identifier for the plan. No length limit is currently enforced.

allowed_payment_methodsstring[]

Payment method types accepted for subscriptions on this plan.

Response

200

idstring
account_idstring
namestring
descriptionstring
merchant_referencestring
statusstring
allowed_payment_methodsstring[]
metadataobject[]
phasesobject[]
created_atstring
updated_atstring

Example response

{
  "status": "ACTIVE"
}