Get Subscription

GET

subscriptions

curl --request GET \
  --url https://api.creem.io/v1/subscriptions \
  --header 'x-api-key: <x-api-key>'

{
  "id": "<string>",
  "mode": "test",
  "object": "subscription",
  "product": {
    "id": "<string>",
    "mode": "test",
    "object": "<string>",
    "name": "<string>",
    "description": "This is a sample product description.",
    "image_url": "https://example.com/image.jpg",
    "features": [
      {
        "id": "<string>",
        "type": "<string>",
        "description": "Get access to discord server."
      }
    ],
    "price": 400,
    "currency": "EUR",
    "billing_type": "recurring",
    "billing_period": "every-month",
    "status": "<string>",
    "tax_mode": "inclusive",
    "tax_category": "saas",
    "product_url": "https://creem.io/product/prod_123123123123",
    "default_success_url": "https://example.com/?status=successful",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z"
  },
  "customer": {
    "id": "<string>",
    "mode": "test",
    "object": "<string>",
    "email": "user@example.com",
    "name": "John Doe",
    "country": "US",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z"
  },
  "items": [
    {
      "id": "<string>",
      "mode": "test",
      "object": "<string>",
      "product_id": "<string>",
      "price_id": "<string>",
      "units": 123
    }
  ],
  "collection_method": "charge_automatically",
  "status": "active",
  "last_transaction_id": "tran_3e6Z6TzvHKdsjEgXnGDEp0",
  "last_transaction": {
    "id": "<string>",
    "mode": "test",
    "object": "transaction",
    "amount": 2000,
    "amount_paid": 2000,
    "discount_amount": 2000,
    "currency": "EUR",
    "type": "<string>",
    "tax_country": "US",
    "tax_amount": 2000,
    "status": "<string>",
    "refunded_amount": 2000,
    "order": "<string>",
    "subscription": "<string>",
    "customer": "<string>",
    "description": "<string>",
    "period_start": 123,
    "period_end": 123,
    "created_at": 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",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-09-12T12:34:56Z"
}

Headers

x-api-key

string

required

Query Parameters

subscription_id

string

required

The unique identifier of the subscription

Response

200 - application/json

Successfully retrieved the subscription

string

required

Unique identifier for the object.

mode

enum<string>

required

String representing the environment.

Available options:

test,

live,

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.

product.id

string

required

Unique identifier for the object.

product.mode

enum<string>

required

String representing the environment.

Available options:

test,

live,

sandbox

product.object

string

required

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

product.name

string

required

The name of the product

product.description

string

required

A brief description of the product

Example:

"This is a sample product description."

product.price

number

required

The price of the product in cents. 1000 = $10.00

Example:

400

product.currency

string

required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

Example:

"EUR"

product.billing_type

string

required

Indicates the billing method for the customer. It can either be a recurring billing cycle or a onetime payment.

Example:

"recurring"

product.billing_period

string

required

Billing period

Example:

"every-month"

product.status

string

required

Status of the product

product.tax_mode

string

required

Specifies the tax calculation mode for the transaction. If set to "inclusive," the tax is included in the price. If set to "exclusive," the tax is added on top of the price.

Example:

"inclusive"

product.tax_category

string

required

Categorizes the type of product or service for tax purposes. This helps determine the applicable tax rules based on the nature of the item or service.

Example:

"saas"

product.created_at

string

required

Creation date of the product

Example:

"2023-01-01T00:00:00Z"

product.updated_at

string

required

Last updated date of the product

Example:

"2023-01-01T00:00:00Z"

product.image_url

string

URL of the product image. Only png as jpg are supported

Example:

"https://example.com/image.jpg"

product.features

object[]

Features of the product.

product.product_url

string

The product page you can redirect your customers to for express checkout.

Example:

"https://creem.io/product/prod_123123123123"

product.default_success_url

string | null

The URL to which the user will be redirected after successfull payment.

Example:

"https://example.com/?status=successful"

customer

required

The customer who owns the subscription.

collection_method

string

required

The method used for collecting payments for the subscription.

Example:

"charge_automatically"

status

enum<string>

required

The current status of the subscription.

Available options:

active,

canceled,

unpaid,

paused,

trialing

Example:

"active"

created_at

string

required

The date and time when the subscription was created.

Example:

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

updated_at

string

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

The date of the last paid transaction.

Example:

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

next_transaction_date

string

The date when the next subscription transaction will be charged.

Example:

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

current_period_start_date

string

The start date of the current subscription period.

Example:

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

current_period_end_date

string

The end date of the current subscription period.

Example:

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

canceled_at

string | null

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

Example:

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

Get Discount Code Update Subscription

curl --request GET \
  --url https://api.creem.io/v1/subscriptions \
  --header 'x-api-key: <x-api-key>'

{
  "id": "<string>",
  "mode": "test",
  "object": "subscription",
  "product": {
    "id": "<string>",
    "mode": "test",
    "object": "<string>",
    "name": "<string>",
    "description": "This is a sample product description.",
    "image_url": "https://example.com/image.jpg",
    "features": [
      {
        "id": "<string>",
        "type": "<string>",
        "description": "Get access to discord server."
      }
    ],
    "price": 400,
    "currency": "EUR",
    "billing_type": "recurring",
    "billing_period": "every-month",
    "status": "<string>",
    "tax_mode": "inclusive",
    "tax_category": "saas",
    "product_url": "https://creem.io/product/prod_123123123123",
    "default_success_url": "https://example.com/?status=successful",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z"
  },
  "customer": {
    "id": "<string>",
    "mode": "test",
    "object": "<string>",
    "email": "user@example.com",
    "name": "John Doe",
    "country": "US",
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z"
  },
  "items": [
    {
      "id": "<string>",
      "mode": "test",
      "object": "<string>",
      "product_id": "<string>",
      "price_id": "<string>",
      "units": 123
    }
  ],
  "collection_method": "charge_automatically",
  "status": "active",
  "last_transaction_id": "tran_3e6Z6TzvHKdsjEgXnGDEp0",
  "last_transaction": {
    "id": "<string>",
    "mode": "test",
    "object": "transaction",
    "amount": 2000,
    "amount_paid": 2000,
    "discount_amount": 2000,
    "currency": "EUR",
    "type": "<string>",
    "tax_country": "US",
    "tax_amount": 2000,
    "status": "<string>",
    "refunded_amount": 2000,
    "order": "<string>",
    "subscription": "<string>",
    "customer": "<string>",
    "description": "<string>",
    "period_start": 123,
    "period_end": 123,
    "created_at": 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",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-09-12T12:34:56Z"
}

API Documentation

Checkout

Product

Customer

Transactions

License

Discount Code

Subscription

Get Subscription

Headers

Query Parameters

Response