---
title: "GET /subscription/get-subscription/{subscriptionId}"
method: GET
path: "/subscription/get-subscription/{subscriptionId}"
---

# GET /subscription/get-subscription/{subscriptionId}

`GET /subscription/get-subscription/{subscriptionId}`

## Path parameters

- `subscriptionId` string, required

## Response `200`

Successful response with subscription details

- GetSubscriptionResponse
  - `subscriptionId` string — Unique identifier of the subscription
  - `interval` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' — The interval group between subscriptions.
  - `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. The first cycle is included in this count.
  - `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
  - `createdAt` string, date-time — Timestamp of when the subscription was created
  - `status` string — The status of the subscription. Refer [subscription statuses](/products/subscription/subscription-statuses)
  - `upfrontAmount` integer — The amount charged to the customer at the time the subscription was activated. This replaces the first billing cycle charge; regular billing resumes from the next cycle.
  - `trialPeriodCount` integer — The number of trial periods before the first billing cycle.
  - `trialPeriodInterval` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' — The interval for the trial period.
  - `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.
  - `updatePaymentMethodLink` string — The URL to redirect the customer to the xPay payment gateway for updating the payment method. Available only for subscriptions in `TRIALING`, `ACTIVE`, or `UNPAID` status.
  - `paymentMetadata` PaymentMetadataDTO — Payment metadata containing additional information about the payment attempt
    - `paymentMethod` string — The payment method used for this attempt. Refer to [supported payment methods](/get-started/payment-methods-supported#payment-method-enums) for a complete list of available payment methods.
    - `cardMetadata` CardMetadataDTO — Card metadata containing additional information about the card used for payment
      - `brand` string — The brand of the card (e.g., `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, `rupay`), among others
      - `country` string — Country code of the card issuer
      - `lastFourDigit` string — Last 4 digits of the card number
      - `expiryMonth` integer — Card expiration month
      - `expiryYear` integer — Card expiration year
      - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'UNKNOWN' — Type of card funding, such as Credit or Debit
    - `cardInstallmentMetadata` CardInstallmentMetadataDTO — Card installment (EMI) metadata, present only for `CARD_INSTALLMENT` payments
      - `cardInstallmentTenure` 'three' | 'six' | 'nine' | 'twelve' — The installment tenure (in months) selected for this payment

## Other responses

- `400` — Invalid request, xSubscriptionId not found

---

[API](https://skmtc.net/xpaycheckout/apis/xpay-api-store.md) · [All operations](https://skmtc.net/xpaycheckout/apis/xpay-api-store/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xpaycheckout/xpay-api-store/versions/6329a7c694bc/schema)