---
title: "Get Subscription"
method: GET
path: "/api/subscription/{orderRef}"
tags: ["Subscription APIs"]
---

# Get Subscription

`GET /api/subscription/{orderRef}`

Use this API for fetching Subscription.

## Path parameters

- `orderRef` string, required

## Headers

- `Content-Type` string
- `X-Portone-Client-Key` string
- `Authorization` string

## Response `200`

Successful response

- object
  - `is_success` boolean — The boolean flag denoting API request execution result
  - `content` SubscriptionContent — The meta details of the subscription
    - `additional_costs` object[] — Additional Cost. Optional for REGULAR Subscription, not available for ONDEMAND Subscription
      - `key` string — Type of cost
      - `value` number, double — Amount
    - `allow_accumulate` string — Indicates whether accumulated payments are allowed. Possible values Y or N
    - `portone_key` string — The unique PortOne key for merchant
    - `created_at` string — The creation date and time of the subscription
    - `currency` string — The currency of the subscription
    - `country_code` string — Country code associated with subscription
    - `customer_email_address` string — Email address of the customer
    - `customer_name` string — Name of the customer
    - `customer_phone_number` string — Phone number of the customer
    - `environment` string — The environment of transacation either live OR sandbox
    - `expired_at` string — The expire date and time of the subscription link
    - `merchant_order_ref` string — The unique merchant order reference generated by the merchant
    - `notes` object[] — Additional Notes
      - `key` string — Title
      - `value` string — Description
    - `notify_by_email` boolean — Specifies if email notifications should be sent
    - `notify_by_phone` boolean — Specifies if phone notifications should be sent
    - `plan_order_ref` string — The reference ID for the plan
    - `quantity` integer — The quantity of the item being subscribed
    - `recurrance_count` number — The number of times the subscription will recur
    - `source` string — The Source of creation.
    - `started_at` string — The start date and time of the subscription
    - `status` string — The status of the subscription link
    - `subscription_type` string — The type of subscription
    - `total_amount` number, double — The total amount of the subscription. Applicable only for REGULAR Subscription
    - `plan_amount` number, double — The amount of the plan. Applicable only for REGULAR Subscription
    - `collected_amount` number, double — The total amount collected till now
    - `total_additional_cost` number, double — The total additional cost of the subscription. Optional for REGULAR Subscription, not available for ONDEMAND Subscription
    - `next_deduction_amount` number, double — The amount for the next deduction
    - `next_deduction_date` string — The date for the next deduction
    - `collected_count` string — The number of times the amount has been collected
    - `trial_frequency` integer — Frequency configured for the trial duration
    - `trial_period` string — Period configured for the trial duration
    - `in_trial` boolean — Indicates whether the subscription is currently in the trial phase
  - `status_code` string — The status_code for API request execution result
  - `status_reason` string — The status_reason for API request execution result

## Other responses

- `400` — Failure response

---

[API](https://skmtc.net/portone/apis/payment-apis.md) · [All operations](https://skmtc.net/portone/apis/payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portone/payment-apis/versions/f3ccea652555/schema)