Skip to main content
POST
Purchase a shared plan

Path Parameters

secret
string
required

Body

application/json
client
object
required

The buyer identity.

confirmationTokenId
string
required

A Stripe confirmation token for the buyer card, resolved into a saved payment method before charging.

customerId
string

Optional Stripe customer id the payment method belongs to. Defaults to the client wallet customer.

Response

200 - application/json
billingType
enum<string>
required

Whether the plan is billed as a one-off or on a recurring basis. Recurring when the plan has a subscription.

Available options:
one_off,
recurring
Example:

"one_off"

id
string
required
createdAt
string
required
clientId
string
required
status
enum<string>
required
Available options:
created,
active,
inactive,
paused,
cancelled,
past_due,
completed
plan
object
required
client
Client · object

Expandable field

organisation
Organisation · object

Expandable field

business
Business · object

Expandable field

bookingCredits
Booking credits · object[]

Expandable field

charges
Charges · object[]

Expandable field

subscription
object