Skip to main content
POST
get subscription

Authorizations

Authorization
string
header
required

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

Body

application/json

Body of the request

customerId
string
required

The customer ID

Example:

"cus_1H7KQFLr7RepUyQBKdnvY"

projectId
string

The project ID

Example:

"prj_1H7KQFLr7RepUyQBKdnvY"

Response

The result of the get subscription

id
string
required
Maximum string length: 36
projectId
string
required
Maximum string length: 36
createdAtM
number
required
updatedAtM
number
required
customerId
string
required
Maximum string length: 36
status
enum<string>
required
Available options:
active,
trialing,
pending_payment,
pending_activation,
canceled,
expired,
past_due
active
boolean
required
planSlug
string
required
Minimum string length: 1
currentCycleStartAt
number
required
currentCycleEndAt
number
required
renewAt
number | null
required
endAt
number | null
required
timezone
string
required
Minimum string length: 1
metadata
object | null
required
project
object
required
customer
object
required
activePhase
object