Skip to content
Trile Docs

Create a subscription for a customer. Idempotency-Key required on retries. Charge is immediate unless price has a trial and skipTrial=false.

POST
/v1/subscriptions

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

Required on every mutating /v1/* endpoint (Phase 1 fixture relaxes to optional)

Request Body required

Section titled “Request Body required ”
object
priceId
required
string
/^price_/
customerId
required
string
/^cus_/
skipTrial
boolean
metadata
object
key
additional properties

Responses

Section titled “ Responses ”

201

Section titled “201 ”
object
success
required
boolean
data
required
object
id
required
string
businessId
required
string
userId
required
string
priceId
required
string
customerId
required
string
status
required
string
Allowed values: trialing active past_due unpaid cancelled
cancelAtPeriodEnd
required
boolean
trialEndAt
required
string format: date-time
nullable
currentPeriodStart
required
string format: date-time
currentPeriodEnd
required
string format: date-time
retryCount
required
integer
>= -9007199254740991 <= 9007199254740991
nextRetryAt
required
string format: date-time
nullable
lastBilledAt
required
string format: date-time
nullable
billingRunId
required
string
nullable
metadata
required
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
meta
required
object
requestId
required
string