Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Default Response

id
string
required
customerId
string
required
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED
billingCycle
object
required
products
object[]
required
activatedAt
null | string
required
invoiceApprovalRequired
boolean
required
changesBehavior
enum<string>
required
Available options:
IMMEDIATE_WITH_PRORATE,
NEXT_CYCLE,
NO_CHANGES
prorateFirstInvoice
boolean
required
createdAt
string
required
endDate
null | string
scheduledPauseAt
null | string
lastPausedAt
null | string
lastResumedAt
null | string
scheduledCancelAt
null | string
trialConfig
object | null
externalCode
null | string
nextBillingDate
null | string
metadata
object | null
updatedAt
null | string