Sign in

v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Subscriptions

Subscription: Show

Show an existing subscription, including its customer and scrubbed payment details.

get/subscriptions/{id}

Path parameters

idstring required

A unique 25-character alphanumeric resource identifier.

Response

200 response

idstring required

A unique 25-character alphanumeric resource identifier.

resource'subscription' required

Resource type name, always "subscription".

statusstring required

Current status of the subscription (e.g. "active", "cancelled").

amountinteger required

Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).

currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND' required

3-letter ISO currency code.

period'weekly' | 'monthly' | 'yearly' required

Interval for subscription payments

dayinteger required

Day of the period on which the subscription is charged.

retry_countinteger required

Number of times payment has been retried after failure.

retry_atstring date-time nullable required

Timestamp of the next scheduled payment retry, or null.

next_capture_atstring date-time required

Timestamp of the next scheduled subscription charge.

created_atstring date-time required

Timestamp when the subscription was created.

ended_atstring date-time nullable required

Timestamp when the subscription ended, or null if still active.

metadataobject required

Arbitrary key-value metadata attached to the subscription.

paymentsUUID[] required

Array of payment UUIDs associated with this subscription.

Example response

{
  "currency": "JPY",
  "customer": {
    "currency": "JPY"
  }
}