Skip to main content
GET
/
subscription
/
get-subscription
/
{subscriptionId}
cURL
curl --request GET \
  --url https://api.xpaycheckout.com/subscription/get-subscription/{subscriptionId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "subscriptionId": "sub_fooBOwYsaK50AEfK",
  "interval": "MONTH",
  "intervalCount": 2,
  "cycleCount": 2,
  "remainingCycleCount": 2,
  "currency": "USD",
  "amount": 100,
  "presentmentCurrency": "USD",
  "createdAt": "2024-09-26T10:41:50.472+00:00",
  "status": "CREATED",
  "description": "Order for 2 items",
  "upfrontAmount": 200,
  "trialPeriodCount": 7,
  "trialPeriodInterval": "DAY",
  "metadata": {
    "orderId": "12345",
    "customerNote": "Deliver after 5 PM"
  }
}

Authorizations

​
Authorization
string
header
required

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

Example:

"sub_fooBOwYsaK50AEfK"

Response

Successful response with subscription details

​
subscriptionId
string

Unique identifier of the subscription

Example:

"sub_fooBOwYsaK50AEfK"

​
interval
enum<string>

The interval group between subscriptions.

Available options:
DAY,
WEEK,
MONTH,
YEAR
Example:

"MONTH"

​
intervalCount
integer

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

Example:

2

​
cycleCount
integer

The number of billing cycles for which the subscription will renew before ending. The first cycle is included in this count.

Example:

2

​
remainingCycleCount
integer

The number of billing cycles remaining for the subscription.

Example:

2

​
currency
string

Three-letter currency code

Example:

"USD"

​
amount
integer

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

Example:

100

​
presentmentCurrency
string

The currency that the customer paid in

Example:

"USD"

​
createdAt
string<date-time>

Timestamp of when the subscription was created

Example:

"2024-09-26T10:41:50.472+00:00"

​
status
enum<string>

The status of the subscription

Available options:
ACTIVE,
INACTIVE,
INCOMPLETE,
CREATED,
CANCELLED
Example:

"CREATED"

​
description
string

Description of the order, if any

Example:

"Order for 2 items"

​
upfrontAmount
integer

The amount to be charged at the start of the subscription. The upfront amount replaces the first subscription cycle amount. Regular amount apply from the next cycle.

Example:

200

​
trialPeriodCount
integer

The number of trial periods before the first billing cycle.

Example:

7

​
trialPeriodInterval
enum<string>

The interval for the trial period.

Available options:
DAY,
WEEK,
MONTH,
YEAR
Example:

"DAY"

​
metadata
object

A collection of key-value pairs that can be attached to an object for storing additional structured information. This is useful for capturing custom data or context-specific attributes.

Constraints:

  • Maximum of 50 key-value pairs allowed.
  • Each key must be no longer than 40 characters.
  • Each value must be a string and cannot exceed 500 characters.
Example:
{
  "orderId": "12345",
  "customerNote": "Deliver after 5 PM"
}
⌘I