API explorerChangelog

Theme switcher

Purchase an addon for a client's membership

Header Parameters

Api-Keystring

Path Parameters

client_idinteger Required
membership_idinteger Required

Client membership ID (as returned by the client memberships endpoint).

Body Parameters

addon_idinteger Required

Addon ID (must be offered for the membership's plan).

pricenumber

Override price. If omitted, the plan's addon price is used.

sale_organization_idinteger

Sale branch. Defaults to the client membership's branch.

discountobject

Show child attributes

Response

200
Object

Created purchase (crud envelope)

Response Attributes

successboolean
dataarray

Show child attributes

errorstring
error_codeinteger
totalinteger
Nullable:
True
summaryobject
401
Object

Session not established / invalid key.

Response Attributes

successboolean
dataarray
errorstring
session_expiredboolean
totalinteger
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot