> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.ordergroove.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.ordergroove.com/_mcp/server.

# Retrieve

GET https://restapi.ordergroove.com/subscriptions/{subscription_id}/

Returns information about a single subscription by its unique identifier.

Reference: https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/retrieve

## Authentication

- `x-api-key` header (required) — Application API Scope — server-to-server, sent in the `x-api-key` header. See [Authentication](/api-reference/authentication).
- `authorization` header (required) — Storefront API Scope — client-side, scoped to one customer, sent as a signature in the `authorization` header. See [Authentication](/api-reference/authentication).

## Request

### Path parameters

- `subscription_id` (string, required) — unique subscription ID

## Response

### 200

200

- `customer` (string, optional)
- `merchant` (string, optional)
- `product` (string, optional)
- `payment` (string, optional)
- `shipping_address` (string, optional)
- `offer` (string, optional)
- `offer_profile_public_id` (string, optional)
- `subscription_type` (string, optional)
- `components` (list of SubscriptionsSubscriptionIdGetResponsesContentApplicationJsonSchemaComponentsItems, optional)
- `extra_data` (SubscriptionsSubscriptionIdGetResponsesContentApplicationJsonSchemaExtraData, optional)
- `public_id` (string, optional)
- `product_attribute` (any, optional)
- `quantity` (integer, optional, default: 0)
- `price` (string, optional, nullable)
- `frequency_days` (integer, optional, default: 0)
- `reminder_days` (integer, optional, default: 0)
- `every` (integer, optional, default: 0)
- `every_period` (integer, optional, default: 0)
- `start_date` (string, optional)
- `cancelled` (string, optional, nullable)
- `cancel_reason` (string, optional, nullable)
- `cancel_reason_code` (integer, optional, nullable)
- `iteration` (any, optional)
- `sequence` (any, optional)
- `session_id` (string, optional)
- `merchant_order_id` (string, optional)
- `customer_rep` (integer, optional, nullable)
- `club` (any, optional)
- `created` (string, optional)
- `updated` (string, optional)
- `live` (boolean, optional, default: true)
- `grantees` (list of Grantee, optional) — List of grantees associated with the subscription. Omitted if the subscription has no grantees.
- `free_trial_subscription_context` (FreeTrialSubscriptionContext, optional) — Present only if the subscription has a free trial context (i.e. it was created for a product with a free trial configured); omitted otherwise.

## Errors

### 403 Forbidden Error

403

- `detail` (string, optional)

### 404 Not Found Error

404

- `detail` (string, optional)

## Types

### SubscriptionsSubscriptionIdGetResponsesContentApplicationJsonSchemaComponentsItems

### SubscriptionsSubscriptionIdGetResponsesContentApplicationJsonSchemaExtraData

### Grantee

- `external_id` (string, required) — External ID of the grantee
- `name` (string, required) — Name of the grantee

### FreeTrialSubscriptionContext

Present only if the subscription has a free trial context (i.e. it was created for a product with a free trial configured); omitted otherwise.

- `product` (string, required) — External product ID of the product the free trial applies to
- `days` (integer, required) — Number of days configured for the free trial
- `conversion_item` (string, required, nullable) — Public ID of the associated conversion item, or null if not applicable
- `expiration` (string, required) — Free trial expiration timestamp, in ISO 8601 format with no timezone offset
- `is_in_free_trial` (boolean, required) — Whether the subscription is still within its free trial period

## Examples

### Result

**Response**

```json
{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "0070067689",
  "payment": "443ddf72094711e9a5afbc764e1043b0",
  "shipping_address": "394aee16d61611e88b4abc764e1043b0",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "offer_profile_public_id": "55a13e38981e43a0a59d30391d91d004",
  "subscription_type": "replenishment",
  "components": [],
  "extra_data": {},
  "public_id": "0ff0f88accc511e8b6c0bc764e106cf4",
  "quantity": 4,
  "price": null,
  "frequency_days": 120,
  "reminder_days": 10,
  "every": 4,
  "every_period": 3,
  "start_date": "2018-12-27",
  "cancelled": null,
  "cancel_reason": null,
  "cancel_reason_code": null,
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "2906548",
  "customer_rep": null,
  "created": "2018-10-10 14:45:38",
  "updated": "2019-01-17 12:09:23",
  "live": true
}
```

**SDK Code**

```python Result
import requests

url = "https://restapi.ordergroove.com/subscriptions/subscription_id/"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Result
const url = 'https://restapi.ordergroove.com/subscriptions/subscription_id/';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Result
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://restapi.ordergroove.com/subscriptions/subscription_id/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Result
require 'uri'
require 'net/http'

url = URI("https://restapi.ordergroove.com/subscriptions/subscription_id/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Result
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://restapi.ordergroove.com/subscriptions/subscription_id/")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Result
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://restapi.ordergroove.com/subscriptions/subscription_id/', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Result
using RestSharp;

var client = new RestClient("https://restapi.ordergroove.com/subscriptions/subscription_id/");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Result
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://restapi.ordergroove.com/subscriptions/subscription_id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### With grantees and free trial

**Response**

```json
{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "0070067689",
  "payment": "443ddf72094711e9a5afbc764e1043b0",
  "shipping_address": "394aee16d61611e88b4abc764e1043b0",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "offer_profile_public_id": "55a13e38981e43a0a59d30391d91d004",
  "subscription_type": "replenishment",
  "components": [],
  "extra_data": {},
  "public_id": "0ff0f88accc511e8b6c0bc764e106cf4",
  "quantity": 4,
  "price": null,
  "frequency_days": 120,
  "reminder_days": 10,
  "every": 4,
  "every_period": 3,
  "start_date": "2018-12-27",
  "cancelled": null,
  "cancel_reason": null,
  "cancel_reason_code": null,
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "2906548",
  "customer_rep": null,
  "created": "2018-10-10 14:45:38",
  "updated": "2019-01-17 12:09:23",
  "live": true,
  "grantees": [
    {
      "external_id": "abc",
      "name": "Grantee 1"
    }
  ],
  "free_trial_subscription_context": {
    "product": "53485191069987",
    "days": 15,
    "conversion_item": "7eeaa504245111eeb185acde48001122",
    "expiration": "2025-09-23T13:12:22.704013",
    "is_in_free_trial": false
  }
}
```

**SDK Code**

```python With grantees and free trial
import requests

url = "https://restapi.ordergroove.com/subscriptions/subscription_id/"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript With grantees and free trial
const url = 'https://restapi.ordergroove.com/subscriptions/subscription_id/';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go With grantees and free trial
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://restapi.ordergroove.com/subscriptions/subscription_id/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby With grantees and free trial
require 'uri'
require 'net/http'

url = URI("https://restapi.ordergroove.com/subscriptions/subscription_id/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java With grantees and free trial
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://restapi.ordergroove.com/subscriptions/subscription_id/")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php With grantees and free trial
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://restapi.ordergroove.com/subscriptions/subscription_id/', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp With grantees and free trial
using RestSharp;

var client = new RestClient("https://restapi.ordergroove.com/subscriptions/subscription_id/");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift With grantees and free trial
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://restapi.ordergroove.com/subscriptions/subscription_id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```