API Reference

Create a subscription

post
https://api.breeze.cash/v1/subscriptions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Subscription details

string
required
string
required
string
required
customer
object
required
trial
object
discountedTrial
object
deprecated

Deprecated: use phases instead.

integer
integer
0 to 90

Number of days after an invoice's due date before the subscription lapses for non-payment. When set, overrides the merchant-level grace period for this subscription; when omitted, the merchant setting (else the platform default) applies. Maximum 90 days.

string
string
preferredPaymentMethods
array of strings
length ≥ 1
phases
array
length between 1 and 10

Optional ordered pricing phases. Each phase bills its own price for a fixed number of billing cycles before advancing to the next phase; once all phases are exhausted the subscription falls back to its default price (the top-level priceId). Cannot be combined with discountedTrial.

phases
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?