API Referenceplans

Subscribe customer to plan

Creates a new order for a customer subscribing to a plan. The order will be created with the plan's products and pricing attributes.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

planIdstringRequiredformat: "uuid"
The ID of the plan

Query parameters

customerExternalIdstringRequired
The external ID of the customer
currencystringRequired

The currency code for the order (e.g., “USD”, “EUR”)

Response

Customer subscribed to plan successfully
idstring or null
namestring or null
descriptionstring or null
customerIdstring or null
organizationIdstring or null
startDatestring or null
endDatestring or null
totalAmountdouble or null
estimatedTaxdouble or null
billedAmountNoTaxdouble or null
billedTaxdouble or null
totalBilledAmountdouble or null
pendingBillingAmountdouble or null
creationStateenum or null
Allowed values:
orderLineslist of objects or null
customerobject or null

Errors