GET
/
subscription
/
get-subscription
/
{subscriptionId}

Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

subscriptionId
string
required

Unique identifier of the subscription

Response

200 - application/json
subscriptionId
string

Unique identifier of the subscription

interval
enum<string>

The interval group between subscriptions.

Available options:
DAY,
WEEK,
MONTH,
YEAR
intervalCount
integer

The number of intervals between subscription billings. For example, interval = MONTH and intervalCount = 3 bills every 3 months.

cycleCount
integer

The number of billing cycles for which the subscription will renew before ending.

remainingCycleCount
integer

The number of billing cycles remaining for the subscription.

currency
string

Three-letter currency code

amount
integer

The amount in lowest count unit (e.g., cents for USD)

presentmentCurrency
string

The currency that the customer paid in

mode
enum<string>

The mode in which the transaction was made (e.g., TEST or LIVE)

Available options:
TEST,
LIVE
createdAt
string

Timestamp of when the subscription was created

status
enum<string>

The status of the subscription

Available options:
ACTIVE,
INACTIVE,
INCOMPLETE,
CREATED,
CANCELLED
description
string

Description of the order, if any

Was this page helpful?

Create SubscriptionCancel Subscription