Subscriptions

Get subscriptions

get

Retrieves all subscriptions for the specified customer token.

This endpoint is only available for stores that use Steam based authentication.

Authorizations

Customer

AuthorizationstringRequired

A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.

Query parameters

customer_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

billing_emailstringOptional

payment_method_idstring · flake-idOptionalExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

trial_idstring · flake-idOptionalExample: 411486491630370816

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

Data transfer object representing a store subscription.

idstring · flake-idRequiredExample: 411486491630370816

pretty_idstringRequired

Human-readable identifier for the subscription.

store_idstring · flake-idRequiredExample: 411486491630370816

payment_method_idstring · flake-idOptionalExample: 411486491630370816

statusstring · enumRequired

Represents the current state of a subscription.

Possible values:

coupon_idstring · flake-idOptionalExample: 411486491630370816

coupon_repeating_ends_atstring · nullableOptional

Date when a repeating coupon ends for this subscription.

affiliate_idstring · flake-idOptionalExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

billing_namestring · nullableOptional

Name used for billing purposes.

billing_emailstring · nullableOptional

Email used for billing purposes.

billing_countrystring · nullableOptional

Country code used for billing purposes.

customer_ipstring · nullableOptional

IP address of the customer at the time of subscription.

giftbooleanRead-onlyRequiredDeprecated

Indicates whether this subscription is a gift.

gift_to_customer_idstring · flake-idOptionalExample: 411486491630370816

product_idstring · flake-idOptionalExample: 411486491630370816

product_version_idstring · flake-idOptionalExample: 411486491630370816

product_namestring · nullableRead-onlyOptionalDeprecated

Name of the product associated with this subscription.

product_image_urlstring · nullableRead-onlyOptionalDeprecated

URL for the product image.

interval_valueinteger · int32Required

Numeric value of the billing interval.

interval_scalestring · enumRequiredPossible values:

currencystringRequired

Currency code used for billing this subscription.

tax_inclusivebooleanRead-onlyRequiredDeprecated

Indicates whether tax is included in the base price itself.

priceinteger · int64Read-onlyRequiredDeprecated

Base price of the subscription in smallest currency units (e.g., cents).

price_strstring · nullableRead-onlyOptionalDeprecated

Formatted string representation of the price.

discount_amountinteger · int64Required

Amount of discount applied in smallest currency units.

discount_amount_strstringRead-onlyRequired

Formatted string representation of the discount amount.

subtotal_amountinteger · int64Required

Subtotal amount in smallest currency units.

subtotal_amount_strstringRead-onlyRequired

Formatted string representation of the subtotal amount.

tax_amountinteger · int64Required

Tax amount in smallest currency units.

tax_amount_strstringRead-onlyRequired

Formatted string representation of the tax amount.

total_amountinteger · int64Required

Total amount in smallest currency units.

total_amount_strstringRead-onlyRequired

Formatted string representation of the total amount.

initial_discount_amountinteger · int64Required

Initial discount amount in smallest currency units for the first billing cycle.

initial_discount_amount_strstringRead-onlyRequired

Formatted string representation of the initial discount amount.

initial_subtotal_amountinteger · int64Required

Initial subtotal amount in smallest currency units for the first billing cycle.

initial_subtotal_amount_strstringRead-onlyRequired

Formatted string representation of the initial subtotal amount.

initial_giftcard_usage_amountinteger · int64Required

Initial gift card usage amount in smallest currency units.

initial_giftcard_usage_amount_strstringRead-onlyRequired

Formatted string representation of the initial gift card usage amount.

initial_tax_amountinteger · int64Required

Initial tax amount in smallest currency units for the first billing cycle.

initial_tax_amount_strstringRead-onlyRequired

Formatted string representation of the initial tax amount.

initial_total_amountinteger · int64Required

Initial total amount in smallest currency units for the first billing cycle.

initial_total_amount_strstringRead-onlyRequired

Formatted string representation of the initial total amount.

presentment_currencystring · nullableOptional

Presentment currency code (currency shown to customer).

presentment_subtotal_amountinteger · nullableOptional

Presentment subtotal amount in smallest currency units.

presentment_subtotal_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the presentment subtotal amount.

presentment_discount_amountinteger · nullableOptional

Presentment discount amount in smallest currency units.

presentment_discount_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the presentment discount amount.

presentment_tax_amountinteger · nullableOptional

Presentment tax amount in smallest currency units.

presentment_tax_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the presentment tax amount.

presentment_total_amountinteger · nullableOptional

Presentment total amount in smallest currency units.

presentment_total_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the presentment total amount.

initial_presentment_discount_amountinteger · nullableOptional

Initial presentment discount amount in smallest currency units for the first billing cycle.

initial_presentment_discount_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment discount amount.

initial_presentment_subtotal_amountinteger · nullableOptional

Initial presentment subtotal amount in smallest currency units for the first billing cycle.

initial_presentment_subtotal_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment subtotal amount.

initial_presentment_giftcard_usage_amountinteger · nullableOptional

Initial presentment gift card usage amount in smallest currency units.

initial_presentment_giftcard_usage_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment gift card usage amount.

initial_presentment_tax_amountinteger · nullableOptional

Initial presentment tax amount in smallest currency units for the first billing cycle.

initial_presentment_tax_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment tax amount.

initial_presentment_total_amountinteger · nullableOptional

Initial presentment total amount in smallest currency units for the first billing cycle.

initial_presentment_total_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment total amount.

fx_ratestring · nullableOptional

The foreign exchange rate applied (if presentment currency differs from settlement currency).

pricing_region_idstring · nullableRead-onlyOptionalDeprecated

Identifier for the pricing region associated with this subscription.

current_period_startstring · nullableOptional

Start date of the current billing period.

current_period_endstring · nullableOptional

End date of the current billing period.

billing_cycle_sequenceinteger · nullableOptional

Sequence number of the current billing cycle.

next_attempt_atstring · nullableOptional

Date and time when the next payment attempt will occur.

attempt_countinteger · nullableOptional

Number of payment attempts made for the current billing cycle.

created_atstring · date-timeRequired

Date and time when the subscription was created.

updated_atstring · nullableOptional

Date and time when the subscription was last updated.

active_atstring · nullableOptional

Date and time when the subscription became active.

canceled_atstring · nullableOptional

Date and time when the subscription was canceled.

cancel_reasonstring · nullableOptional

Reason provided for cancellation.

default

Error response

application/json

get

/v1/store/customer/subscriptions

HTTPcURLJavaScriptPython

GET /v1/store/customer/subscriptions HTTP/1.1
Authorization: Customer TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "store_id": "411486491630370816",
    "store": {
      "id": "411486491630370816",
      "slug": "m0ukas-awesome-store",
      "name": "m0uka's awesome store",
      "platform": "rust",
      "game": "text",
      "currency": "eur",
      "creator_currency": "usd",
      "description": null,
      "website_url": null,
      "support_email": "[email protected]",
      "support_url": null,
      "integration_type": null,
      "live_mode": true,
      "logo_url": null,
      "logo_square_url": null,
      "created_at": null,
      "updated_at": null
    },
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "store": {
        "id": "411486491630370816",
        "trust": {
          "store_id": "411486491630370816",
          "status": "invalid",
          "status_reason": null,
          "restrictions": "none",
          "created_at": "2026-03-31T12:18:43.244Z",
          "updated_at": null,
          "onboarding_steps": {
            "store_id": "411486491630370816",
            "store_owner_id": "411486491630370816",
            "payout_onboarding_completed": true,
            "kyc_completed": true,
            "products_created": true,
            "gameserver_linked": true,
            "webhooks_active": true,
            "downloadable_files_added": true
          },
          "events": [
            {
              "id": "411486491630370816",
              "store_id": "411486491630370816",
              "type": "invalid",
              "description": null,
              "store_requirement_id": "411486491630370816",
              "store_review_id": "411486491630370816",
              "actor": {
                "type": "anonymous",
                "id": "411486491630370816"
              },
              "created_at": "2026-03-31T12:18:43.244Z"
            }
          ],
          "pending_requirements": [
            {
              "id": "411486491630370816",
              "store_id": "411486491630370816",
              "template_id": null,
              "originating_flag_id": "411486491630370816",
              "category": "invalid",
              "code": "text",
              "name": "text",
              "description": null,
              "schema": null,
              "metadata": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "status": "invalid",
              "requested_by": "invalid",
              "requested_by_detail": null,
              "created_at": "2026-03-31T12:18:43.244Z",
              "updated_at": null,
              "deadline_at": null,
              "submitted_at": null,
              "verified_at": null,
              "rejected_at": null,
              "restricts_capabilities": [
                "text"
              ],
              "submissions": [
                {
                  "id": "411486491630370816",
                  "store_id": "411486491630370816",
                  "store_requirement_id": "411486491630370816",
                  "store_requirement_field_id": "text",
                  "text_value": null,
                  "file_id": null,
                  "file_name": null,
                  "file_content_type": null,
                  "file_size_bytes": null,
                  "submitted_at": "2026-03-31T12:18:43.244Z",
                  "submitted_by": {
                    "type": "anonymous",
                    "id": "411486491630370816"
                  },
                  "submitted_by_ip_address": null,
                  "submitted_by_user_agent": null
                }
              ]
            }
          ]
        },
        "owner_id": "411486491630370816",
        "slug": "text",
        "name": "text",
        "platform": "text",
        "game": "text",
        "currency": "text",
        "description": "text",
        "website_url": null,
        "contact_email": null,
        "support_email": null,
        "support_url": null,
        "integration_type": null,
        "live_mode": true,
        "logo_url": null,
        "logo_square_url": null,
        "minecraft_bedrock_username_prefix": null,
        "created_at": null,
        "updated_at": null,
        "onboarding_completed_at": null,
        "platform_store_type_association": {
          "platform_id": "411486491630370816",
          "associated_platform": {
            "id": "411486491630370816",
            "slug": "text",
            "type": "invalid",
            "country_code": "text",
            "business_name": "text",
            "name": "text",
            "description": "text",
            "website_url": "text",
            "logo_url": "text",
            "accent_color": "text",
            "capabilities": [
              "invalid"
            ],
            "created_at": "2026-03-31T12:18:43.244Z",
            "updated_at": "2026-03-31T12:18:43.244Z",
            "disabled_at": null
          },
          "store_platform": "text",
          "paynow_platform_fee_percentage_override": null,
          "connected_platform_fee_percentage": null,
          "connected_platform_wallet_id": null,
          "disable_billing_plans": true,
          "display_disclaimers": true,
          "full_external_management": true
        },
        "members": [
          {
            "id": "411486491630370816",
            "user_id": "411486491630370816",
            "user": {
              "type": "anonymous",
              "id": "411486491630370816",
              "email": null,
              "first_name": null,
              "last_name": null,
              "nickname": null
            },
            "added_at": null,
            "added_by": {
              "type": "anonymous",
              "id": "411486491630370816"
            },
            "role_id": "411486491630370816"
          }
        ]
      },
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-03-31T12:18:43.244Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "payment_method_id": "411486491630370816",
    "payment_method": {
      "id": "411486491630370816",
      "customer_id": "411486491630370816",
      "gateway": "text",
      "gateway_id": "text",
      "gateway_customer_id": "text",
      "gateway_type": "card",
      "method_type": "card",
      "method_details": {
        "card": {
          "brand": "visa",
          "country": "US",
          "exp_month": 12,
          "exp_year": 2028,
          "fingerprint": "abc123def456",
          "funding": "credit",
          "last4": "4242",
          "bin": 424242,
          "issuer": "Chase Bank",
          "description": "Visa Signature",
          "wallet": {
            "type": "apple_pay"
          }
        },
        "cashapp": {
          "buyer_id": "buyer_abc123",
          "cashtag": "$johndoe"
        },
        "paypal": {
          "payer_id": "PAYERID123",
          "payer_email": "[email protected]",
          "payer_name": "John Doe",
          "country": "US",
          "vault": true,
          "pending_vault_approval": false,
          "standalone_setup": false
        },
        "link": {
          "email": "[email protected]"
        },
        "crypto": {
          "crypto_currency": "BTC",
          "crypto_amount": "0.00150000",
          "total_paid": "0.00150000",
          "confirmations": 6
        },
        "steamskins": {
          "items": [
            {
              "id": "text",
              "app_id": 730,
              "name": "AK-47 | Redline",
              "price": 2500
            }
          ]
        },
        "ideal": {
          "bank": "abn_amro",
          "bic": "ABNANL2A",
          "iban_last4": 1234,
          "payer_name": "John Doe"
        },
        "p24": {
          "bank": "ing",
          "payer_name": "Jan Kowalski"
        },
        "bancontact": {
          "bank": "bnp_paribas",
          "bank_name": "BNP Paribas",
          "bic": "GEBABEBB",
          "iban_last4": 3456,
          "payer_name": "Jean Dupont"
        },
        "klarna": {
          "country": "SE",
          "method_category": "pay_later"
        },
        "alipay": {
          "buyer_id": "buyer_abc123",
          "fingerprint": "fingerprint_xyz789"
        },
        "pay_by_bank": {
          "bank_name": "Chase Bank",
          "bic": "CHASUS33",
          "country": "US",
          "payer_name": "John Smith"
        },
        "pix": {
          "bank_name": "Banco do Brasil",
          "bank_account_number": "12345-6",
          "payer_name": "João Silva"
        }
      },
      "created_at": "2025-03-15T10:20:30Z",
      "gateway_entity_identifier": "text",
      "updated_at": "2025-03-20T14:30:00Z"
    },
    "pending_change": {
      "id": "411486491630370816",
      "subscription_id": "411486491630370816",
      "prorated_order_id": "411486491630370816",
      "status": "invalid",
      "proration_behavior": "invalid",
      "off_session": true,
      "prorated_amount": {
        "currency": "text",
        "prorated_amount": 1,
        "presentment_currency": "text",
        "presentment_prorated_amount": 1
      },
      "created_at": "2026-03-31T12:18:43.244Z",
      "applied_at": null,
      "lines": [
        {
          "id": "411486491630370816",
          "subscription_line_id": "411486491630370816",
          "is_deleted": true,
          "tax_inclusive": true,
          "price": 1,
          "product": {
            "id": "411486491630370816",
            "version_id": "411486491630370816",
            "name": "text",
            "image_url": null,
            "selected_gameserver_id": "411486491630370816",
            "pricing_region_id": null,
            "custom_variables": {
              "ANY_ADDITIONAL_PROPERTY": {
                "id": "411486491630370816",
                "identifier": "text",
                "name": "text",
                "description": "text",
                "price": 1,
                "value": "text"
              }
            }
          },
          "amount": {
            "currency": "text",
            "subtotal": 1,
            "discount": 1,
            "tax": 1,
            "total": 1
          },
          "presentment_amount": {
            "currency": "text",
            "subtotal": 1,
            "discount": 1,
            "tax": 1,
            "total": 1
          },
          "prorated_amount": 1,
          "prorated_presentment_amount": 1,
          "remaining_minutes": 1,
          "total_minutes": 1
        }
      ],
      "next_billing_amount": {
        "currency": "text",
        "subtotal": 1,
        "discount": 1,
        "tax": 1,
        "total": 1
      },
      "next_billing_presentment_amount": {
        "currency": "text",
        "subtotal": 1,
        "discount": 1,
        "tax": 1,
        "total": 1
      }
    },
    "next_billing_amount": {
      "currency": "text",
      "subtotal": 1,
      "discount": 1,
      "tax": 1,
      "total": 1
    },
    "next_billing_presentment_amount": {
      "currency": "text",
      "subtotal": 1,
      "discount": 1,
      "tax": 1,
      "total": 1
    },
    "status": "invalid",
    "coupon_id": "411486491630370816",
    "coupon_repeating_ends_at": null,
    "affiliate_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "billing_name": null,
    "billing_email": null,
    "billing_country": null,
    "tax_jurisdictions": [
      {
        "name": "EU OSS",
        "taxes": [
          {
            "tax_name": "text",
            "taxable_amount": "text",
            "tax_amount": "text",
            "tax_rate": "text"
          }
        ],
        "not_taxed_reason": null
      }
    ],
    "customer_ip": null,
    "gift_to_customer_id": "411486491630370816",
    "gift_to_customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "store": {
        "id": "411486491630370816",
        "trust": {
          "store_id": "411486491630370816",
          "status": "invalid",
          "status_reason": null,
          "restrictions": "none",
          "created_at": "2026-03-31T12:18:43.244Z",
          "updated_at": null,
          "onboarding_steps": {
            "store_id": "411486491630370816",
            "store_owner_id": "411486491630370816",
            "payout_onboarding_completed": true,
            "kyc_completed": true,
            "products_created": true,
            "gameserver_linked": true,
            "webhooks_active": true,
            "downloadable_files_added": true
          },
          "events": [
            {
              "id": "411486491630370816",
              "store_id": "411486491630370816",
              "type": "invalid",
              "description": null,
              "store_requirement_id": "411486491630370816",
              "store_review_id": "411486491630370816",
              "actor": {
                "type": "anonymous",
                "id": "411486491630370816"
              },
              "created_at": "2026-03-31T12:18:43.244Z"
            }
          ],
          "pending_requirements": [
            {
              "id": "411486491630370816",
              "store_id": "411486491630370816",
              "template_id": null,
              "originating_flag_id": "411486491630370816",
              "category": "invalid",
              "code": "text",
              "name": "text",
              "description": null,
              "schema": null,
              "metadata": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "status": "invalid",
              "requested_by": "invalid",
              "requested_by_detail": null,
              "created_at": "2026-03-31T12:18:43.244Z",
              "updated_at": null,
              "deadline_at": null,
              "submitted_at": null,
              "verified_at": null,
              "rejected_at": null,
              "restricts_capabilities": [
                "text"
              ],
              "submissions": [
                {
                  "id": "411486491630370816",
                  "store_id": "411486491630370816",
                  "store_requirement_id": "411486491630370816",
                  "store_requirement_field_id": "text",
                  "text_value": null,
                  "file_id": null,
                  "file_name": null,
                  "file_content_type": null,
                  "file_size_bytes": null,
                  "submitted_at": "2026-03-31T12:18:43.244Z",
                  "submitted_by": {
                    "type": "anonymous",
                    "id": "411486491630370816"
                  },
                  "submitted_by_ip_address": null,
                  "submitted_by_user_agent": null
                }
              ]
            }
          ]
        },
        "owner_id": "411486491630370816",
        "slug": "text",
        "name": "text",
        "platform": "text",
        "game": "text",
        "currency": "text",
        "description": "text",
        "website_url": null,
        "contact_email": null,
        "support_email": null,
        "support_url": null,
        "integration_type": null,
        "live_mode": true,
        "logo_url": null,
        "logo_square_url": null,
        "minecraft_bedrock_username_prefix": null,
        "created_at": null,
        "updated_at": null,
        "onboarding_completed_at": null,
        "platform_store_type_association": {
          "platform_id": "411486491630370816",
          "associated_platform": {
            "id": "411486491630370816",
            "slug": "text",
            "type": "invalid",
            "country_code": "text",
            "business_name": "text",
            "name": "text",
            "description": "text",
            "website_url": "text",
            "logo_url": "text",
            "accent_color": "text",
            "capabilities": [
              "invalid"
            ],
            "created_at": "2026-03-31T12:18:43.244Z",
            "updated_at": "2026-03-31T12:18:43.244Z",
            "disabled_at": null
          },
          "store_platform": "text",
          "paynow_platform_fee_percentage_override": null,
          "connected_platform_fee_percentage": null,
          "connected_platform_wallet_id": null,
          "disable_billing_plans": true,
          "display_disclaimers": true,
          "full_external_management": true
        },
        "members": [
          {
            "id": "411486491630370816",
            "user_id": "411486491630370816",
            "user": {
              "type": "anonymous",
              "id": "411486491630370816",
              "email": null,
              "first_name": null,
              "last_name": null,
              "nickname": null
            },
            "added_at": null,
            "added_by": {
              "type": "anonymous",
              "id": "411486491630370816"
            },
            "role_id": "411486491630370816"
          }
        ]
      },
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-03-31T12:18:43.244Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "interval_value": 1,
    "interval_scale": "invalid",
    "currency": "text",
    "discount_amount": 1,
    "discount_amount_str": "text",
    "subtotal_amount": 1,
    "subtotal_amount_str": "text",
    "tax_amount": 1,
    "tax_amount_str": "text",
    "total_amount": 1,
    "total_amount_str": "text",
    "initial_discount_amount": 1,
    "initial_discount_amount_str": "text",
    "initial_subtotal_amount": 1,
    "initial_subtotal_amount_str": "text",
    "initial_giftcard_usage_amount": 1,
    "initial_giftcard_usage_amount_str": "text",
    "initial_tax_amount": 1,
    "initial_tax_amount_str": "text",
    "initial_total_amount": 1,
    "initial_total_amount_str": "text",
    "presentment_currency": null,
    "presentment_subtotal_amount": null,
    "presentment_subtotal_amount_str": null,
    "presentment_discount_amount": null,
    "presentment_discount_amount_str": null,
    "presentment_tax_amount": null,
    "presentment_tax_amount_str": null,
    "presentment_total_amount": null,
    "presentment_total_amount_str": null,
    "initial_presentment_discount_amount": null,
    "initial_presentment_discount_amount_str": null,
    "initial_presentment_subtotal_amount": null,
    "initial_presentment_subtotal_amount_str": null,
    "initial_presentment_giftcard_usage_amount": null,
    "initial_presentment_giftcard_usage_amount_str": null,
    "initial_presentment_tax_amount": null,
    "initial_presentment_tax_amount_str": null,
    "initial_presentment_total_amount": null,
    "initial_presentment_total_amount_str": null,
    "fx_rate": null,
    "current_period_start": null,
    "current_period_end": null,
    "billing_cycle_sequence": null,
    "next_attempt_at": null,
    "attempt_count": null,
    "created_at": "2026-03-31T12:18:43.244Z",
    "updated_at": null,
    "active_at": null,
    "canceled_at": null,
    "cancel_reason": null,
    "lines": [
      {
        "id": "411486491630370816",
        "subscription_id": "411486491630370816",
        "checkout_line_id": "411486491630370816",
        "initial_order_line_id": "411486491630370816",
        "pricing_region_id": null,
        "gift_to_customer_id": "411486491630370816",
        "gift_to_customer": {
          "id": "411486491630370816",
          "store_id": "411486491630370816",
          "store": {
            "id": "411486491630370816",
            "trust": {
              "store_id": "411486491630370816",
              "status": "invalid",
              "status_reason": null,
              "restrictions": "none",
              "created_at": "2026-03-31T12:18:43.244Z",
              "updated_at": null,
              "onboarding_steps": {
                "store_id": "411486491630370816",
                "store_owner_id": "411486491630370816",
                "payout_onboarding_completed": true,
                "kyc_completed": true,
                "products_created": true,
                "gameserver_linked": true,
                "webhooks_active": true,
                "downloadable_files_added": true
              },
              "events": [
                {
                  "id": "411486491630370816",
                  "store_id": "411486491630370816",
                  "type": "invalid",
                  "description": null,
                  "store_requirement_id": "411486491630370816",
                  "store_review_id": "411486491630370816",
                  "actor": {
                    "type": "anonymous",
                    "id": "411486491630370816"
                  },
                  "created_at": "2026-03-31T12:18:43.244Z"
                }
              ],
              "pending_requirements": [
                {
                  "id": "411486491630370816",
                  "store_id": "411486491630370816",
                  "template_id": null,
                  "originating_flag_id": "411486491630370816",
                  "category": "invalid",
                  "code": "text",
                  "name": "text",
                  "description": null,
                  "schema": null,
                  "metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "status": "invalid",
                  "requested_by": "invalid",
                  "requested_by_detail": null,
                  "created_at": "2026-03-31T12:18:43.244Z",
                  "updated_at": null,
                  "deadline_at": null,
                  "submitted_at": null,
                  "verified_at": null,
                  "rejected_at": null,
                  "restricts_capabilities": [
                    "text"
                  ],
                  "submissions": [
                    {
                      "id": "411486491630370816",
                      "store_id": "411486491630370816",
                      "store_requirement_id": "411486491630370816",
                      "store_requirement_field_id": "text",
                      "text_value": null,
                      "file_id": null,
                      "file_name": null,
                      "file_content_type": null,
                      "file_size_bytes": null,
                      "submitted_at": "2026-03-31T12:18:43.244Z",
                      "submitted_by": {
                        "type": "anonymous",
                        "id": "411486491630370816"
                      },
                      "submitted_by_ip_address": null,
                      "submitted_by_user_agent": null
                    }
                  ]
                }
              ]
            },
            "owner_id": "411486491630370816",
            "slug": "text",
            "name": "text",
            "platform": "text",
            "game": "text",
            "currency": "text",
            "description": "text",
            "website_url": null,
            "contact_email": null,
            "support_email": null,
            "support_url": null,
            "integration_type": null,
            "live_mode": true,
            "logo_url": null,
            "logo_square_url": null,
            "minecraft_bedrock_username_prefix": null,
            "created_at": null,
            "updated_at": null,
            "onboarding_completed_at": null,
            "platform_store_type_association": {
              "platform_id": "411486491630370816",
              "associated_platform": {
                "id": "411486491630370816",
                "slug": "text",
                "type": "invalid",
                "country_code": "text",
                "business_name": "text",
                "name": "text",
                "description": "text",
                "website_url": "text",
                "logo_url": "text",
                "accent_color": "text",
                "capabilities": [
                  "invalid"
                ],
                "created_at": "2026-03-31T12:18:43.244Z",
                "updated_at": "2026-03-31T12:18:43.244Z",
                "disabled_at": null
              },
              "store_platform": "text",
              "paynow_platform_fee_percentage_override": null,
              "connected_platform_fee_percentage": null,
              "connected_platform_wallet_id": null,
              "disable_billing_plans": true,
              "display_disclaimers": true,
              "full_external_management": true
            },
            "members": [
              {
                "id": "411486491630370816",
                "user_id": "411486491630370816",
                "user": {
                  "type": "anonymous",
                  "id": "411486491630370816",
                  "email": null,
                  "first_name": null,
                  "last_name": null,
                  "nickname": null
                },
                "added_at": null,
                "added_by": {
                  "type": "anonymous",
                  "id": "411486491630370816"
                },
                "role_id": "411486491630370816"
              }
            ]
          },
          "profile": {
            "id": "text",
            "platform": "steam",
            "name": "text",
            "avatar_url": null
          },
          "steam_id": "76561197960287930",
          "steam": {
            "id": "76561197960287930",
            "name": "text",
            "avatar_url": "text"
          },
          "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
          "minecraft": {
            "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
            "name": "notch",
            "avatar_url": "text"
          },
          "xbox_xuid": null,
          "minecraft_platform": "unknown",
          "name": "m0uka",
          "created_at": "2026-03-31T12:18:43.244Z",
          "updated_at": null,
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "selected_gameserver_id": "411486491630370816",
        "sale_id": "411486491630370816",
        "trial_id": "411486491630370816",
        "product_id": "411486491630370816",
        "product_version_id": "411486491630370816",
        "product_name": "text",
        "product_image_url": null,
        "tax_inclusive": true,
        "currency": "text",
        "price": 1,
        "discount_amount": 1,
        "discount_amount_str": "text",
        "subtotal_amount": 1,
        "subtotal_amount_str": "text",
        "tax_amount": 1,
        "tax_amount_str": "text",
        "total_amount": 1,
        "total_amount_str": "text",
        "initial_discount_amount": 1,
        "initial_discount_amount_str": "text",
        "initial_subtotal_amount": 1,
        "initial_subtotal_amount_str": "text",
        "initial_giftcard_usage_amount": 1,
        "initial_giftcard_usage_amount_str": "text",
        "initial_tax_amount": 1,
        "initial_tax_amount_str": "text",
        "initial_total_amount": 1,
        "initial_total_amount_str": "text",
        "presentment_currency": null,
        "presentment_subtotal_amount": null,
        "presentment_subtotal_amount_str": null,
        "presentment_discount_amount": null,
        "presentment_discount_amount_str": null,
        "presentment_tax_amount": null,
        "presentment_tax_amount_str": null,
        "presentment_total_amount": null,
        "presentment_total_amount_str": null,
        "initial_presentment_discount_amount": null,
        "initial_presentment_discount_amount_str": null,
        "initial_presentment_subtotal_amount": null,
        "initial_presentment_subtotal_amount_str": null,
        "initial_presentment_giftcard_usage_amount": null,
        "initial_presentment_giftcard_usage_amount_str": null,
        "initial_presentment_tax_amount": null,
        "initial_presentment_tax_amount_str": null,
        "initial_presentment_total_amount": null,
        "initial_presentment_total_amount_str": null
      }
    ]
  }
]

Get subscription by ID

get

Retrieves a subscription for the specified store by the supplied customer token.

This endpoint is only available for stores that use Steam based authentication.

Authorizations

Customer

AuthorizationstringRequired

A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.

Path parameters

subscriptionIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

Data transfer object representing a store subscription.

idstring · flake-idRequiredExample: 411486491630370816

pretty_idstringRequired

Human-readable identifier for the subscription.

store_idstring · flake-idRequiredExample: 411486491630370816

payment_method_idstring · flake-idOptionalExample: 411486491630370816

statusstring · enumRequired

Represents the current state of a subscription.

Possible values:

coupon_idstring · flake-idOptionalExample: 411486491630370816

coupon_repeating_ends_atstring · nullableOptional

Date when a repeating coupon ends for this subscription.

affiliate_idstring · flake-idOptionalExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

billing_namestring · nullableOptional

Name used for billing purposes.

billing_emailstring · nullableOptional

Email used for billing purposes.

billing_countrystring · nullableOptional

Country code used for billing purposes.

customer_ipstring · nullableOptional

IP address of the customer at the time of subscription.

giftbooleanRead-onlyRequiredDeprecated

Indicates whether this subscription is a gift.

gift_to_customer_idstring · flake-idOptionalExample: 411486491630370816

product_idstring · flake-idOptionalExample: 411486491630370816

product_version_idstring · flake-idOptionalExample: 411486491630370816

product_namestring · nullableRead-onlyOptionalDeprecated

Name of the product associated with this subscription.

product_image_urlstring · nullableRead-onlyOptionalDeprecated

URL for the product image.

interval_valueinteger · int32Required

Numeric value of the billing interval.

interval_scalestring · enumRequiredPossible values:

currencystringRequired

Currency code used for billing this subscription.

tax_inclusivebooleanRead-onlyRequiredDeprecated

Indicates whether tax is included in the base price itself.

priceinteger · int64Read-onlyRequiredDeprecated

Base price of the subscription in smallest currency units (e.g., cents).

price_strstring · nullableRead-onlyOptionalDeprecated

Formatted string representation of the price.

discount_amountinteger · int64Required

Amount of discount applied in smallest currency units.

discount_amount_strstringRead-onlyRequired

Formatted string representation of the discount amount.

subtotal_amountinteger · int64Required

Subtotal amount in smallest currency units.

subtotal_amount_strstringRead-onlyRequired

Formatted string representation of the subtotal amount.

tax_amountinteger · int64Required

Tax amount in smallest currency units.

tax_amount_strstringRead-onlyRequired

Formatted string representation of the tax amount.

total_amountinteger · int64Required

Total amount in smallest currency units.

total_amount_strstringRead-onlyRequired

Formatted string representation of the total amount.

initial_discount_amountinteger · int64Required

Initial discount amount in smallest currency units for the first billing cycle.

initial_discount_amount_strstringRead-onlyRequired

Formatted string representation of the initial discount amount.

initial_subtotal_amountinteger · int64Required

Initial subtotal amount in smallest currency units for the first billing cycle.

initial_subtotal_amount_strstringRead-onlyRequired

Formatted string representation of the initial subtotal amount.

initial_giftcard_usage_amountinteger · int64Required

Initial gift card usage amount in smallest currency units.

initial_giftcard_usage_amount_strstringRead-onlyRequired

Formatted string representation of the initial gift card usage amount.

initial_tax_amountinteger · int64Required

Initial tax amount in smallest currency units for the first billing cycle.

initial_tax_amount_strstringRead-onlyRequired

Formatted string representation of the initial tax amount.

initial_total_amountinteger · int64Required

Initial total amount in smallest currency units for the first billing cycle.

initial_total_amount_strstringRead-onlyRequired

Formatted string representation of the initial total amount.

presentment_currencystring · nullableOptional

Presentment currency code (currency shown to customer).

presentment_subtotal_amountinteger · nullableOptional

Presentment subtotal amount in smallest currency units.

presentment_subtotal_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the presentment subtotal amount.

presentment_discount_amountinteger · nullableOptional

Presentment discount amount in smallest currency units.

presentment_discount_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the presentment discount amount.

presentment_tax_amountinteger · nullableOptional

Presentment tax amount in smallest currency units.

presentment_tax_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the presentment tax amount.

presentment_total_amountinteger · nullableOptional

Presentment total amount in smallest currency units.

presentment_total_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the presentment total amount.

initial_presentment_discount_amountinteger · nullableOptional

Initial presentment discount amount in smallest currency units for the first billing cycle.

initial_presentment_discount_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment discount amount.

initial_presentment_subtotal_amountinteger · nullableOptional

Initial presentment subtotal amount in smallest currency units for the first billing cycle.

initial_presentment_subtotal_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment subtotal amount.

initial_presentment_giftcard_usage_amountinteger · nullableOptional

Initial presentment gift card usage amount in smallest currency units.

initial_presentment_giftcard_usage_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment gift card usage amount.

initial_presentment_tax_amountinteger · nullableOptional

Initial presentment tax amount in smallest currency units for the first billing cycle.

initial_presentment_tax_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment tax amount.

initial_presentment_total_amountinteger · nullableOptional

Initial presentment total amount in smallest currency units for the first billing cycle.

initial_presentment_total_amount_strstring · nullableRead-onlyOptional

Formatted string representation of the initial presentment total amount.

fx_ratestring · nullableOptional

The foreign exchange rate applied (if presentment currency differs from settlement currency).

pricing_region_idstring · nullableRead-onlyOptionalDeprecated

Identifier for the pricing region associated with this subscription.

current_period_startstring · nullableOptional

Start date of the current billing period.

current_period_endstring · nullableOptional

End date of the current billing period.

billing_cycle_sequenceinteger · nullableOptional

Sequence number of the current billing cycle.

next_attempt_atstring · nullableOptional

Date and time when the next payment attempt will occur.

attempt_countinteger · nullableOptional

Number of payment attempts made for the current billing cycle.

created_atstring · date-timeRequired

Date and time when the subscription was created.

updated_atstring · nullableOptional

Date and time when the subscription was last updated.

active_atstring · nullableOptional

Date and time when the subscription became active.

canceled_atstring · nullableOptional

Date and time when the subscription was canceled.

cancel_reasonstring · nullableOptional

Reason provided for cancellation.

default

Error response

application/json

get

/v1/store/customer/subscriptions/{subscriptionId}

HTTPcURLJavaScriptPython

GET /v1/store/customer/subscriptions/{subscriptionId} HTTP/1.1
Authorization: Customer TOKEN_HERE
Accept: */*

{
  "id": "411486491630370816",
  "pretty_id": "text",
  "store_id": "411486491630370816",
  "store": {
    "id": "411486491630370816",
    "slug": "m0ukas-awesome-store",
    "name": "m0uka's awesome store",
    "platform": "rust",
    "game": "text",
    "currency": "eur",
    "creator_currency": "usd",
    "description": null,
    "website_url": null,
    "support_email": "[email protected]",
    "support_url": null,
    "integration_type": null,
    "live_mode": true,
    "logo_url": null,
    "logo_square_url": null,
    "created_at": null,
    "updated_at": null
  },
  "customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "store": {
      "id": "411486491630370816",
      "trust": {
        "store_id": "411486491630370816",
        "status": "invalid",
        "status_reason": null,
        "restrictions": "none",
        "created_at": "2026-03-31T12:18:43.244Z",
        "updated_at": null,
        "onboarding_steps": {
          "store_id": "411486491630370816",
          "store_owner_id": "411486491630370816",
          "payout_onboarding_completed": true,
          "kyc_completed": true,
          "products_created": true,
          "gameserver_linked": true,
          "webhooks_active": true,
          "downloadable_files_added": true
        },
        "events": [
          {
            "id": "411486491630370816",
            "store_id": "411486491630370816",
            "type": "invalid",
            "description": null,
            "store_requirement_id": "411486491630370816",
            "store_review_id": "411486491630370816",
            "actor": {
              "type": "anonymous",
              "id": "411486491630370816"
            },
            "created_at": "2026-03-31T12:18:43.244Z"
          }
        ],
        "pending_requirements": [
          {
            "id": "411486491630370816",
            "store_id": "411486491630370816",
            "template_id": null,
            "originating_flag_id": "411486491630370816",
            "category": "invalid",
            "code": "text",
            "name": "text",
            "description": null,
            "schema": null,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "status": "invalid",
            "requested_by": "invalid",
            "requested_by_detail": null,
            "created_at": "2026-03-31T12:18:43.244Z",
            "updated_at": null,
            "deadline_at": null,
            "submitted_at": null,
            "verified_at": null,
            "rejected_at": null,
            "restricts_capabilities": [
              "text"
            ],
            "submissions": [
              {
                "id": "411486491630370816",
                "store_id": "411486491630370816",
                "store_requirement_id": "411486491630370816",
                "store_requirement_field_id": "text",
                "text_value": null,
                "file_id": null,
                "file_name": null,
                "file_content_type": null,
                "file_size_bytes": null,
                "submitted_at": "2026-03-31T12:18:43.244Z",
                "submitted_by": {
                  "type": "anonymous",
                  "id": "411486491630370816"
                },
                "submitted_by_ip_address": null,
                "submitted_by_user_agent": null
              }
            ]
          }
        ]
      },
      "owner_id": "411486491630370816",
      "slug": "text",
      "name": "text",
      "platform": "text",
      "game": "text",
      "currency": "text",
      "description": "text",
      "website_url": null,
      "contact_email": null,
      "support_email": null,
      "support_url": null,
      "integration_type": null,
      "live_mode": true,
      "logo_url": null,
      "logo_square_url": null,
      "minecraft_bedrock_username_prefix": null,
      "created_at": null,
      "updated_at": null,
      "onboarding_completed_at": null,
      "platform_store_type_association": {
        "platform_id": "411486491630370816",
        "associated_platform": {
          "id": "411486491630370816",
          "slug": "text",
          "type": "invalid",
          "country_code": "text",
          "business_name": "text",
          "name": "text",
          "description": "text",
          "website_url": "text",
          "logo_url": "text",
          "accent_color": "text",
          "capabilities": [
            "invalid"
          ],
          "created_at": "2026-03-31T12:18:43.244Z",
          "updated_at": "2026-03-31T12:18:43.244Z",
          "disabled_at": null
        },
        "store_platform": "text",
        "paynow_platform_fee_percentage_override": null,
        "connected_platform_fee_percentage": null,
        "connected_platform_wallet_id": null,
        "disable_billing_plans": true,
        "display_disclaimers": true,
        "full_external_management": true
      },
      "members": [
        {
          "id": "411486491630370816",
          "user_id": "411486491630370816",
          "user": {
            "type": "anonymous",
            "id": "411486491630370816",
            "email": null,
            "first_name": null,
            "last_name": null,
            "nickname": null
          },
          "added_at": null,
          "added_by": {
            "type": "anonymous",
            "id": "411486491630370816"
          },
          "role_id": "411486491630370816"
        }
      ]
    },
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": null
    },
    "steam_id": "76561197960287930",
    "steam": {
      "id": "76561197960287930",
      "name": "text",
      "avatar_url": "text"
    },
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "minecraft": {
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "name": "notch",
      "avatar_url": "text"
    },
    "xbox_xuid": null,
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2026-03-31T12:18:43.244Z",
    "updated_at": null,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "payment_method_id": "411486491630370816",
  "payment_method": {
    "id": "411486491630370816",
    "customer_id": "411486491630370816",
    "gateway": "text",
    "gateway_id": "text",
    "gateway_customer_id": "text",
    "gateway_type": "card",
    "method_type": "card",
    "method_details": {
      "card": {
        "brand": "visa",
        "country": "US",
        "exp_month": 12,
        "exp_year": 2028,
        "fingerprint": "abc123def456",
        "funding": "credit",
        "last4": "4242",
        "bin": 424242,
        "issuer": "Chase Bank",
        "description": "Visa Signature",
        "wallet": {
          "type": "apple_pay"
        }
      },
      "cashapp": {
        "buyer_id": "buyer_abc123",
        "cashtag": "$johndoe"
      },
      "paypal": {
        "payer_id": "PAYERID123",
        "payer_email": "[email protected]",
        "payer_name": "John Doe",
        "country": "US",
        "vault": true,
        "pending_vault_approval": false,
        "standalone_setup": false
      },
      "link": {
        "email": "[email protected]"
      },
      "crypto": {
        "crypto_currency": "BTC",
        "crypto_amount": "0.00150000",
        "total_paid": "0.00150000",
        "confirmations": 6
      },
      "steamskins": {
        "items": [
          {
            "id": "text",
            "app_id": 730,
            "name": "AK-47 | Redline",
            "price": 2500
          }
        ]
      },
      "ideal": {
        "bank": "abn_amro",
        "bic": "ABNANL2A",
        "iban_last4": 1234,
        "payer_name": "John Doe"
      },
      "p24": {
        "bank": "ing",
        "payer_name": "Jan Kowalski"
      },
      "bancontact": {
        "bank": "bnp_paribas",
        "bank_name": "BNP Paribas",
        "bic": "GEBABEBB",
        "iban_last4": 3456,
        "payer_name": "Jean Dupont"
      },
      "klarna": {
        "country": "SE",
        "method_category": "pay_later"
      },
      "alipay": {
        "buyer_id": "buyer_abc123",
        "fingerprint": "fingerprint_xyz789"
      },
      "pay_by_bank": {
        "bank_name": "Chase Bank",
        "bic": "CHASUS33",
        "country": "US",
        "payer_name": "John Smith"
      },
      "pix": {
        "bank_name": "Banco do Brasil",
        "bank_account_number": "12345-6",
        "payer_name": "João Silva"
      }
    },
    "created_at": "2025-03-15T10:20:30Z",
    "gateway_entity_identifier": "text",
    "updated_at": "2025-03-20T14:30:00Z"
  },
  "pending_change": {
    "id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "prorated_order_id": "411486491630370816",
    "status": "invalid",
    "proration_behavior": "invalid",
    "off_session": true,
    "prorated_amount": {
      "currency": "text",
      "prorated_amount": 1,
      "presentment_currency": "text",
      "presentment_prorated_amount": 1
    },
    "created_at": "2026-03-31T12:18:43.244Z",
    "applied_at": null,
    "lines": [
      {
        "id": "411486491630370816",
        "subscription_line_id": "411486491630370816",
        "is_deleted": true,
        "tax_inclusive": true,
        "price": 1,
        "product": {
          "id": "411486491630370816",
          "version_id": "411486491630370816",
          "name": "text",
          "image_url": null,
          "selected_gameserver_id": "411486491630370816",
          "pricing_region_id": null,
          "custom_variables": {
            "ANY_ADDITIONAL_PROPERTY": {
              "id": "411486491630370816",
              "identifier": "text",
              "name": "text",
              "description": "text",
              "price": 1,
              "value": "text"
            }
          }
        },
        "amount": {
          "currency": "text",
          "subtotal": 1,
          "discount": 1,
          "tax": 1,
          "total": 1
        },
        "presentment_amount": {
          "currency": "text",
          "subtotal": 1,
          "discount": 1,
          "tax": 1,
          "total": 1
        },
        "prorated_amount": 1,
        "prorated_presentment_amount": 1,
        "remaining_minutes": 1,
        "total_minutes": 1
      }
    ],
    "next_billing_amount": {
      "currency": "text",
      "subtotal": 1,
      "discount": 1,
      "tax": 1,
      "total": 1
    },
    "next_billing_presentment_amount": {
      "currency": "text",
      "subtotal": 1,
      "discount": 1,
      "tax": 1,
      "total": 1
    }
  },
  "next_billing_amount": {
    "currency": "text",
    "subtotal": 1,
    "discount": 1,
    "tax": 1,
    "total": 1
  },
  "next_billing_presentment_amount": {
    "currency": "text",
    "subtotal": 1,
    "discount": 1,
    "tax": 1,
    "total": 1
  },
  "status": "invalid",
  "coupon_id": "411486491630370816",
  "coupon_repeating_ends_at": null,
  "affiliate_id": "411486491630370816",
  "checkout_id": "411486491630370816",
  "checkout_line_id": "411486491630370816",
  "billing_name": null,
  "billing_email": null,
  "billing_country": null,
  "tax_jurisdictions": [
    {
      "name": "EU OSS",
      "taxes": [
        {
          "tax_name": "text",
          "taxable_amount": "text",
          "tax_amount": "text",
          "tax_rate": "text"
        }
      ],
      "not_taxed_reason": null
    }
  ],
  "customer_ip": null,
  "gift_to_customer_id": "411486491630370816",
  "gift_to_customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "store": {
      "id": "411486491630370816",
      "trust": {
        "store_id": "411486491630370816",
        "status": "invalid",
        "status_reason": null,
        "restrictions": "none",
        "created_at": "2026-03-31T12:18:43.244Z",
        "updated_at": null,
        "onboarding_steps": {
          "store_id": "411486491630370816",
          "store_owner_id": "411486491630370816",
          "payout_onboarding_completed": true,
          "kyc_completed": true,
          "products_created": true,
          "gameserver_linked": true,
          "webhooks_active": true,
          "downloadable_files_added": true
        },
        "events": [
          {
            "id": "411486491630370816",
            "store_id": "411486491630370816",
            "type": "invalid",
            "description": null,
            "store_requirement_id": "411486491630370816",
            "store_review_id": "411486491630370816",
            "actor": {
              "type": "anonymous",
              "id": "411486491630370816"
            },
            "created_at": "2026-03-31T12:18:43.244Z"
          }
        ],
        "pending_requirements": [
          {
            "id": "411486491630370816",
            "store_id": "411486491630370816",
            "template_id": null,
            "originating_flag_id": "411486491630370816",
            "category": "invalid",
            "code": "text",
            "name": "text",
            "description": null,
            "schema": null,
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "status": "invalid",
            "requested_by": "invalid",
            "requested_by_detail": null,
            "created_at": "2026-03-31T12:18:43.244Z",
            "updated_at": null,
            "deadline_at": null,
            "submitted_at": null,
            "verified_at": null,
            "rejected_at": null,
            "restricts_capabilities": [
              "text"
            ],
            "submissions": [
              {
                "id": "411486491630370816",
                "store_id": "411486491630370816",
                "store_requirement_id": "411486491630370816",
                "store_requirement_field_id": "text",
                "text_value": null,
                "file_id": null,
                "file_name": null,
                "file_content_type": null,
                "file_size_bytes": null,
                "submitted_at": "2026-03-31T12:18:43.244Z",
                "submitted_by": {
                  "type": "anonymous",
                  "id": "411486491630370816"
                },
                "submitted_by_ip_address": null,
                "submitted_by_user_agent": null
              }
            ]
          }
        ]
      },
      "owner_id": "411486491630370816",
      "slug": "text",
      "name": "text",
      "platform": "text",
      "game": "text",
      "currency": "text",
      "description": "text",
      "website_url": null,
      "contact_email": null,
      "support_email": null,
      "support_url": null,
      "integration_type": null,
      "live_mode": true,
      "logo_url": null,
      "logo_square_url": null,
      "minecraft_bedrock_username_prefix": null,
      "created_at": null,
      "updated_at": null,
      "onboarding_completed_at": null,
      "platform_store_type_association": {
        "platform_id": "411486491630370816",
        "associated_platform": {
          "id": "411486491630370816",
          "slug": "text",
          "type": "invalid",
          "country_code": "text",
          "business_name": "text",
          "name": "text",
          "description": "text",
          "website_url": "text",
          "logo_url": "text",
          "accent_color": "text",
          "capabilities": [
            "invalid"
          ],
          "created_at": "2026-03-31T12:18:43.244Z",
          "updated_at": "2026-03-31T12:18:43.244Z",
          "disabled_at": null
        },
        "store_platform": "text",
        "paynow_platform_fee_percentage_override": null,
        "connected_platform_fee_percentage": null,
        "connected_platform_wallet_id": null,
        "disable_billing_plans": true,
        "display_disclaimers": true,
        "full_external_management": true
      },
      "members": [
        {
          "id": "411486491630370816",
          "user_id": "411486491630370816",
          "user": {
            "type": "anonymous",
            "id": "411486491630370816",
            "email": null,
            "first_name": null,
            "last_name": null,
            "nickname": null
          },
          "added_at": null,
          "added_by": {
            "type": "anonymous",
            "id": "411486491630370816"
          },
          "role_id": "411486491630370816"
        }
      ]
    },
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": null
    },
    "steam_id": "76561197960287930",
    "steam": {
      "id": "76561197960287930",
      "name": "text",
      "avatar_url": "text"
    },
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "minecraft": {
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "name": "notch",
      "avatar_url": "text"
    },
    "xbox_xuid": null,
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2026-03-31T12:18:43.244Z",
    "updated_at": null,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "product_id": "411486491630370816",
  "product_version_id": "411486491630370816",
  "interval_value": 1,
  "interval_scale": "invalid",
  "currency": "text",
  "discount_amount": 1,
  "discount_amount_str": "text",
  "subtotal_amount": 1,
  "subtotal_amount_str": "text",
  "tax_amount": 1,
  "tax_amount_str": "text",
  "total_amount": 1,
  "total_amount_str": "text",
  "initial_discount_amount": 1,
  "initial_discount_amount_str": "text",
  "initial_subtotal_amount": 1,
  "initial_subtotal_amount_str": "text",
  "initial_giftcard_usage_amount": 1,
  "initial_giftcard_usage_amount_str": "text",
  "initial_tax_amount": 1,
  "initial_tax_amount_str": "text",
  "initial_total_amount": 1,
  "initial_total_amount_str": "text",
  "presentment_currency": null,
  "presentment_subtotal_amount": null,
  "presentment_subtotal_amount_str": null,
  "presentment_discount_amount": null,
  "presentment_discount_amount_str": null,
  "presentment_tax_amount": null,
  "presentment_tax_amount_str": null,
  "presentment_total_amount": null,
  "presentment_total_amount_str": null,
  "initial_presentment_discount_amount": null,
  "initial_presentment_discount_amount_str": null,
  "initial_presentment_subtotal_amount": null,
  "initial_presentment_subtotal_amount_str": null,
  "initial_presentment_giftcard_usage_amount": null,
  "initial_presentment_giftcard_usage_amount_str": null,
  "initial_presentment_tax_amount": null,
  "initial_presentment_tax_amount_str": null,
  "initial_presentment_total_amount": null,
  "initial_presentment_total_amount_str": null,
  "fx_rate": null,
  "current_period_start": null,
  "current_period_end": null,
  "billing_cycle_sequence": null,
  "next_attempt_at": null,
  "attempt_count": null,
  "created_at": "2026-03-31T12:18:43.244Z",
  "updated_at": null,
  "active_at": null,
  "canceled_at": null,
  "cancel_reason": null,
  "lines": [
    {
      "id": "411486491630370816",
      "subscription_id": "411486491630370816",
      "checkout_line_id": "411486491630370816",
      "initial_order_line_id": "411486491630370816",
      "pricing_region_id": null,
      "gift_to_customer_id": "411486491630370816",
      "gift_to_customer": {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "store": {
          "id": "411486491630370816",
          "trust": {
            "store_id": "411486491630370816",
            "status": "invalid",
            "status_reason": null,
            "restrictions": "none",
            "created_at": "2026-03-31T12:18:43.244Z",
            "updated_at": null,
            "onboarding_steps": {
              "store_id": "411486491630370816",
              "store_owner_id": "411486491630370816",
              "payout_onboarding_completed": true,
              "kyc_completed": true,
              "products_created": true,
              "gameserver_linked": true,
              "webhooks_active": true,
              "downloadable_files_added": true
            },
            "events": [
              {
                "id": "411486491630370816",
                "store_id": "411486491630370816",
                "type": "invalid",
                "description": null,
                "store_requirement_id": "411486491630370816",
                "store_review_id": "411486491630370816",
                "actor": {
                  "type": "anonymous",
                  "id": "411486491630370816"
                },
                "created_at": "2026-03-31T12:18:43.244Z"
              }
            ],
            "pending_requirements": [
              {
                "id": "411486491630370816",
                "store_id": "411486491630370816",
                "template_id": null,
                "originating_flag_id": "411486491630370816",
                "category": "invalid",
                "code": "text",
                "name": "text",
                "description": null,
                "schema": null,
                "metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "status": "invalid",
                "requested_by": "invalid",
                "requested_by_detail": null,
                "created_at": "2026-03-31T12:18:43.244Z",
                "updated_at": null,
                "deadline_at": null,
                "submitted_at": null,
                "verified_at": null,
                "rejected_at": null,
                "restricts_capabilities": [
                  "text"
                ],
                "submissions": [
                  {
                    "id": "411486491630370816",
                    "store_id": "411486491630370816",
                    "store_requirement_id": "411486491630370816",
                    "store_requirement_field_id": "text",
                    "text_value": null,
                    "file_id": null,
                    "file_name": null,
                    "file_content_type": null,
                    "file_size_bytes": null,
                    "submitted_at": "2026-03-31T12:18:43.244Z",
                    "submitted_by": {
                      "type": "anonymous",
                      "id": "411486491630370816"
                    },
                    "submitted_by_ip_address": null,
                    "submitted_by_user_agent": null
                  }
                ]
              }
            ]
          },
          "owner_id": "411486491630370816",
          "slug": "text",
          "name": "text",
          "platform": "text",
          "game": "text",
          "currency": "text",
          "description": "text",
          "website_url": null,
          "contact_email": null,
          "support_email": null,
          "support_url": null,
          "integration_type": null,
          "live_mode": true,
          "logo_url": null,
          "logo_square_url": null,
          "minecraft_bedrock_username_prefix": null,
          "created_at": null,
          "updated_at": null,
          "onboarding_completed_at": null,
          "platform_store_type_association": {
            "platform_id": "411486491630370816",
            "associated_platform": {
              "id": "411486491630370816",
              "slug": "text",
              "type": "invalid",
              "country_code": "text",
              "business_name": "text",
              "name": "text",
              "description": "text",
              "website_url": "text",
              "logo_url": "text",
              "accent_color": "text",
              "capabilities": [
                "invalid"
              ],
              "created_at": "2026-03-31T12:18:43.244Z",
              "updated_at": "2026-03-31T12:18:43.244Z",
              "disabled_at": null
            },
            "store_platform": "text",
            "paynow_platform_fee_percentage_override": null,
            "connected_platform_fee_percentage": null,
            "connected_platform_wallet_id": null,
            "disable_billing_plans": true,
            "display_disclaimers": true,
            "full_external_management": true
          },
          "members": [
            {
              "id": "411486491630370816",
              "user_id": "411486491630370816",
              "user": {
                "type": "anonymous",
                "id": "411486491630370816",
                "email": null,
                "first_name": null,
                "last_name": null,
                "nickname": null
              },
              "added_at": null,
              "added_by": {
                "type": "anonymous",
                "id": "411486491630370816"
              },
              "role_id": "411486491630370816"
            }
          ]
        },
        "profile": {
          "id": "text",
          "platform": "steam",
          "name": "text",
          "avatar_url": null
        },
        "steam_id": "76561197960287930",
        "steam": {
          "id": "76561197960287930",
          "name": "text",
          "avatar_url": "text"
        },
        "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "minecraft": {
          "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
          "name": "notch",
          "avatar_url": "text"
        },
        "xbox_xuid": null,
        "minecraft_platform": "unknown",
        "name": "m0uka",
        "created_at": "2026-03-31T12:18:43.244Z",
        "updated_at": null,
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "selected_gameserver_id": "411486491630370816",
      "sale_id": "411486491630370816",
      "trial_id": "411486491630370816",
      "product_id": "411486491630370816",
      "product_version_id": "411486491630370816",
      "product_name": "text",
      "product_image_url": null,
      "tax_inclusive": true,
      "currency": "text",
      "price": 1,
      "discount_amount": 1,
      "discount_amount_str": "text",
      "subtotal_amount": 1,
      "subtotal_amount_str": "text",
      "tax_amount": 1,
      "tax_amount_str": "text",
      "total_amount": 1,
      "total_amount_str": "text",
      "initial_discount_amount": 1,
      "initial_discount_amount_str": "text",
      "initial_subtotal_amount": 1,
      "initial_subtotal_amount_str": "text",
      "initial_giftcard_usage_amount": 1,
      "initial_giftcard_usage_amount_str": "text",
      "initial_tax_amount": 1,
      "initial_tax_amount_str": "text",
      "initial_total_amount": 1,
      "initial_total_amount_str": "text",
      "presentment_currency": null,
      "presentment_subtotal_amount": null,
      "presentment_subtotal_amount_str": null,
      "presentment_discount_amount": null,
      "presentment_discount_amount_str": null,
      "presentment_tax_amount": null,
      "presentment_tax_amount_str": null,
      "presentment_total_amount": null,
      "presentment_total_amount_str": null,
      "initial_presentment_discount_amount": null,
      "initial_presentment_discount_amount_str": null,
      "initial_presentment_subtotal_amount": null,
      "initial_presentment_subtotal_amount_str": null,
      "initial_presentment_giftcard_usage_amount": null,
      "initial_presentment_giftcard_usage_amount_str": null,
      "initial_presentment_tax_amount": null,
      "initial_presentment_tax_amount_str": null,
      "initial_presentment_total_amount": null,
      "initial_presentment_total_amount_str": null
    }
  ]
}

Cancel subscription by ID

delete

Cancels a subscription for the specified store by the supplied customer token.

This endpoint is only available for stores that use Steam based authentication.

Authorizations

Customer

AuthorizationstringRequired

A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.

Path parameters

subscriptionIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

default

Error response

application/json

delete

/v1/store/customer/subscriptions/{subscriptionId}

HTTPcURLJavaScriptPython

DELETE /v1/store/customer/subscriptions/{subscriptionId} HTTP/1.1
Authorization: Customer TOKEN_HERE
Accept: */*

No content