Skip to main content
GET
Get a subscription

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Success.

id
string<uuid>
required
status
enum<string>
required
Available options:
ACTIVE,
FAILING,
PAUSED,
CANCELLED,
COMPLETED
amount
number
required
currency
string
required
billingPeriod
enum<string>
required
Available options:
WEEKLY,
BIWEEKLY,
MONTHLY,
QUARTERLY,
SEMIANNUAL,
YEARLY
chargedPeriods
integer
maxBillingCycles
integer | null

Null means it runs until cancelled.

failedAttempts
integer

Consecutive failures within the current cycle.

maxFailedAttempts
integer
failedBillingCycles
integer
maxFailedBillingCycles
integer

The subscription is cancelled when this is reached.

nextBillingDate
string<date-time> | null
lastBillingDate
string<date-time> | null
startedAt
string<date-time>
cancelledAt
string<date-time> | null
endedAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>
customer
object | null
card
object | null

The card, masked. The full number and the stored token are never returned.

totalCollected
number

Detail endpoint only. Sum of every pending and confirmed payment.

daysActive
integer

Detail endpoint only.