Skip to main content
GET
/
v1
/
subscriptions
Retrieve a subscription
curl --request GET \
  --url https://api.creem.io/v1/subscriptions \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.creem.io/v1/subscriptions"

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

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

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.creem.io/v1/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.creem.io/v1/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.creem.io/v1/subscriptions"

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

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

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.creem.io/v1/subscriptions")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.creem.io/v1/subscriptions")

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

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

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "object": "subscription",
  "product": {
    "id": "<string>",
    "object": "<string>",
    "name": "<string>",
    "description": "This is a sample product description.",
    "price": 400,
    "currency": "USD",
    "billing_type": "recurring",
    "billing_period": "every-month",
    "tax_mode": "inclusive",
    "tax_category": "saas",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z",
    "image_url": "https://example.com/image.jpg",
    "features": [
      {
        "id": "feat_abc123",
        "type": "licenseKey",
        "description": "Access to premium course materials."
      }
    ],
    "product_url": "https://creem.io/product/prod_123123123123",
    "default_success_url": "https://example.com/?status=successful",
    "custom_fields": [
      {
        "key": "<string>",
        "label": "<string>",
        "optional": true,
        "text": {
          "max_length": 123,
          "minimum_length": 123,
          "value": "<string>"
        },
        "checkbox": {
          "label": "<string>",
          "value": true
        }
      }
    ]
  },
  "customer": {
    "id": "<string>",
    "object": "<string>",
    "email": "user@example.com",
    "country": "US",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z",
    "name": "John Doe",
    "metadata": {
      "key": "value"
    }
  },
  "collection_method": "charge_automatically",
  "status": "active",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-09-12T12:34:56Z",
  "items": [
    {
      "id": "<string>",
      "object": "<string>",
      "product_id": "<string>",
      "price_id": "<string>",
      "units": 123
    }
  ],
  "last_transaction_id": "tran_3e6Z6TzvHKdsjEgXnGDEp0",
  "last_transaction": {
    "id": "<string>",
    "object": "transaction",
    "amount": 2000,
    "currency": "USD",
    "created_at": 123,
    "amount_paid": 2000,
    "discount_amount": 2000,
    "tax_country": "US",
    "tax_amount": 2000,
    "refunded_amount": 2000,
    "order": "<string>",
    "subscription": "<string>",
    "customer": "<string>",
    "description": "<string>",
    "period_start": 123,
    "period_end": 123
  },
  "last_transaction_date": "2024-09-12T12:34:56Z",
  "next_transaction_date": "2024-09-12T12:34:56Z",
  "current_period_start_date": "2024-09-12T12:34:56Z",
  "current_period_end_date": "2024-09-12T12:34:56Z",
  "canceled_at": "2024-09-12T12:34:56Z",
  "discount": {
    "id": "dis_3e6Z6TzvHKdsjEgXnGDEp0",
    "discountCode": "HOLIDAY2024",
    "name": "<string>",
    "amount": 123,
    "durationInMonths": 123
  },
  "metadata": {
    "userId": "user_123",
    "plan": "pro"
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Query Parameters

subscription_id
string
required

The unique identifier of the subscription

Example:

"sub_1234567890"

Response

Successfully retrieved the subscription

id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
object
string
required

String representing the object's type. Objects of the same type share the same value.

Example:

"subscription"

product
required

The product associated with the subscription.

customer
required

The customer who owns the subscription.

collection_method
enum<string>
required

The method used for collecting payments for the subscription.

Available options:
charge_automatically
Example:

"charge_automatically"

status
enum<string>
required

The current status of the subscription.

Available options:
active,
canceled,
unpaid,
paused,
trialing,
scheduled_cancel,
past_due
Example:

"active"

created_at
string<date-time>
required

The date and time when the subscription was created.

Example:

"2024-01-01T00:00:00Z"

updated_at
string<date-time>
required

The date and time when the subscription was last updated.

Example:

"2024-09-12T12:34:56Z"

items
object[]

Subscription items.

last_transaction_id
string

The ID of the last paid transaction.

Example:

"tran_3e6Z6TzvHKdsjEgXnGDEp0"

last_transaction
object

The last paid transaction.

last_transaction_date
string<date-time>

The date of the last paid transaction.

Example:

"2024-09-12T12:34:56Z"

next_transaction_date
string<date-time>

The date when the next subscription transaction will be charged.

Example:

"2024-09-12T12:34:56Z"

current_period_start_date
string<date-time>

The start date of the current subscription period.

Example:

"2024-09-12T12:34:56Z"

current_period_end_date
string<date-time>

The end date of the current subscription period.

Example:

"2024-09-12T12:34:56Z"

canceled_at
string<date-time> | null

The date and time when the subscription was canceled, if applicable.

Example:

"2024-09-12T12:34:56Z"

discount
object

The discount applied to the subscription, if any.

metadata
object

Metadata for the subscription in the form of key-value pairs.

Example:
{ "userId": "user_123", "plan": "pro" }