Skip to main content
POST
Create subscription link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
plan
enum<string>
required
Available options:
pro,
business,
enterprise
billing
enum<string>
default:monthly
Available options:
monthly,
annual

Response

Short-lived Stripe-hosted billing link.

object
string
required
Allowed value: "billing_link"
kind
enum<string>
required
Available options:
checkout,
subscription_update_confirm,
billing_portal
url
string<uri>
required
target_plan
enum<string> | null
required
Available options:
pro,
business,
enterprise,
null
target_billing
enum<string> | null
required
Available options:
monthly,
annual,
null
expires_at
string<date-time> | null
required
requires_customer_confirmation
boolean
required
request_id
string
required