Create a Subscription

Creates one or more Subscriptions. Specify the Customer, Customer's OpenID, plan, quantity of Subscriptions, affiliate code (brandCode) and tax code in the request body.

Body Params
string
required

Unique Customer identifier. This is a parameter inherited from Stripe, where the Customer entity stores billing and tax information for Subscriptions. In SideDrawer, a Customer entity contains the customer's name and billing details and is used to create a Subscription.

string

Sponsor OpenID. OpenID is an open standard authentication method used as identification for Users, like a username or email might be used.

string
required

Unique Plan identifier.

number
required

Quantity of the plans acquired.

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

string

Tax code.

Response
200

Successfully created a Subscription.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!