Create a Subscription

Overview

Create a new Subscription for a business. Supports discounted and free plans using coupons.

Available for Staff tokens.

Token Permissions

Token TypeAllowedRestrictions
StaffYesCannot set custom pricing. For external payment type offerings, must use a Staff token created by a Directory token.
DirectoryNoMust create a Staff token first via POST /platform/v1/tokens
InternalNoMust create a Staff token first
Billing AppYesCannot set custom pricing
Regular AppNoNot allowed

Important: External Payment Type Offerings

Offerings with payment_type = external require a Staff token created by a Directory token:

  1. Use POST /platform/v1/tokens with a Directory token to create a Staff token for the target business.
  2. Use that Staff token to call this endpoint.

The buyer_uid in the subscription is automatically derived from the authenticated Staff token's identity.

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