API Reference
Log In
API Reference

Subscriptions

Only Tenant owners can own a Subscription.

A User may have a sponsored Subscription. The subscriptionFeatures object provides more information about a Subscription, if applicable.


{
  "customer": "{customer}",
  "openId": "auth0|12345abcde",
  "plan": "Plan name",
  "quantity": 0,
  "brandCode": "{brandCode}",
  "taxId": "{taxId}"
}

Subscription entity

customer string required
Unique Customer identifier.


openId string
Sponsor's OpenID.


plan string required
Unique Plan identifier.


quantity number required
Quantity of Plans acquired.


brandCode string
Affiliate code (brandCode).


taxId string
Tax code.