Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subscriptions

Get subscriptions

get

Retrieves all subscriptions for the specified store.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to retrieve subscriptions for.

Example: 411486491630370816
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_idsstring · flake-id[]Required

Identifiers of coupons applied to this subscription.

Example: 411486491630370816
coupon_repeating_ends_atstring · nullableOptionalDeprecated

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.

billing_tax_idstring · nullableOptional

The tax identification number used for this order (for B2B transactions)

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.

cancellation_requested_atstring · nullableOptional

Date and time when a subscription cancellation (cancel_at_period_end) was requested.

cancel_at_period_endbooleanRead-onlyRequired

Whether the subscription will be canceled at the end of the billing period.

past_duebooleanRequired

Whether the subscription is past due, and is in a dunning (retrying) state.

get/v1/stores/{storeId}/subscriptions
GET /v1/stores/{storeId}/subscriptions HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "store_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_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-01-01T00:00:00.000Z",
      "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",
          "brand_product": "F",
          "wallet": {
            "type": "apple_pay"
          }
        },
        "cashapp": {
          "buyer_id": "buyer_abc123",
          "cashtag": "$johndoe"
        },
        "paypal": {
          "payer_id": "PAYERID123",
          "payer_email": "john.doe@example.com",
          "payer_name": "John Doe",
          "country": "US",
          "vault": true,
          "pending_vault_approval": false,
          "standalone_setup": false
        },
        "link": {
          "email": "john.doe@example.com"
        },
        "crypto": {
          "crypto_currency": "BTC",
          "crypto_amount": "0.00150000",
          "total_paid": "0.00150000",
          "confirmations": 6,
          "transaction_hashes": [
            "text"
          ]
        },
        "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"
        },
        "paysafecard": {
          "first_name": null,
          "last_name": null,
          "psc_id": null,
          "association_id": null
        }
      },
      "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-01-01T00:00:00.000Z",
      "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_ids": [
      "411486491630370816"
    ],
    "affiliate_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "billing_name": null,
    "billing_email": null,
    "billing_country": null,
    "billing_tax_id": 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",
      "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-01-01T00:00:00.000Z",
      "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-01-01T00:00:00.000Z",
    "updated_at": null,
    "active_at": null,
    "canceled_at": null,
    "cancel_reason": null,
    "cancellation_requested_at": null,
    "cancel_at_period_end": true,
    "past_due": true,
    "lines": [
      {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "subscription_id": "411486491630370816",
        "checkout_line_id": "411486491630370816",
        "initial_order_line_id": "411486491630370816",
        "pricing_region_id": null,
        "gift_to_customer_id": "411486491630370816",
        "selected_gameserver_id": "411486491630370816",
        "sale_id": "411486491630370816",
        "sale_version_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 ID.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to retrieve the subscription for.

Example: 411486491630370816
subscriptionIdstring · flake-idRequired

The ID of the subscription.

Example: 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_idsstring · flake-id[]Required

Identifiers of coupons applied to this subscription.

Example: 411486491630370816
coupon_repeating_ends_atstring · nullableOptionalDeprecated

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.

billing_tax_idstring · nullableOptional

The tax identification number used for this order (for B2B transactions)

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.

cancellation_requested_atstring · nullableOptional

Date and time when a subscription cancellation (cancel_at_period_end) was requested.

cancel_at_period_endbooleanRead-onlyRequired

Whether the subscription will be canceled at the end of the billing period.

past_duebooleanRequired

Whether the subscription is past due, and is in a dunning (retrying) state.

get/v1/stores/{storeId}/subscriptions/{subscriptionId}
GET /v1/stores/{storeId}/subscriptions/{subscriptionId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "id": "411486491630370816",
  "pretty_id": "text",
  "store_id": "411486491630370816",
  "customer": {
    "id": "411486491630370816",
    "store_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-01-01T00:00:00.000Z",
    "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",
        "brand_product": "F",
        "wallet": {
          "type": "apple_pay"
        }
      },
      "cashapp": {
        "buyer_id": "buyer_abc123",
        "cashtag": "$johndoe"
      },
      "paypal": {
        "payer_id": "PAYERID123",
        "payer_email": "john.doe@example.com",
        "payer_name": "John Doe",
        "country": "US",
        "vault": true,
        "pending_vault_approval": false,
        "standalone_setup": false
      },
      "link": {
        "email": "john.doe@example.com"
      },
      "crypto": {
        "crypto_currency": "BTC",
        "crypto_amount": "0.00150000",
        "total_paid": "0.00150000",
        "confirmations": 6,
        "transaction_hashes": [
          "text"
        ]
      },
      "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"
      },
      "paysafecard": {
        "first_name": null,
        "last_name": null,
        "psc_id": null,
        "association_id": null
      }
    },
    "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-01-01T00:00:00.000Z",
    "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_ids": [
    "411486491630370816"
  ],
  "affiliate_id": "411486491630370816",
  "checkout_id": "411486491630370816",
  "checkout_line_id": "411486491630370816",
  "billing_name": null,
  "billing_email": null,
  "billing_country": null,
  "billing_tax_id": 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",
    "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-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
  "updated_at": null,
  "active_at": null,
  "canceled_at": null,
  "cancel_reason": null,
  "cancellation_requested_at": null,
  "cancel_at_period_end": true,
  "past_due": true,
  "lines": [
    {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "subscription_id": "411486491630370816",
      "checkout_line_id": "411486491630370816",
      "initial_order_line_id": "411486491630370816",
      "pricing_region_id": null,
      "gift_to_customer_id": "411486491630370816",
      "selected_gameserver_id": "411486491630370816",
      "sale_id": "411486491630370816",
      "sale_version_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

post

Cancels a subscription for the specified store by the supplied ID.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to cancel the subscription for.

Example: 411486491630370816
subscriptionIdstring · flake-idRequired

The ID of the subscription.

Example: 411486491630370816
Body
cancel_at_period_endboolean · nullableOptional

Should the subscription be cancelled immediately (false) or on the next billing period (true)?

Responses
204

No Content

No content
post/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel
POST /v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "cancel_at_period_end": null
}
No content

Stop pending subscription cancellation

post

Stops a pending subscription cancellation for the specified store by the supplied ID.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to uncancel the subscription for.

Example: 411486491630370816
subscriptionIdstring · flake-idRequired

The ID of the subscription.

Example: 411486491630370816
Responses
204

No Content

No content
post/v1/stores/{storeId}/subscriptions/{subscriptionId}/stop-pending-cancellation
POST /v1/stores/{storeId}/subscriptions/{subscriptionId}/stop-pending-cancellation HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

No content

Update items on a subscription

post

Updates the subscription lines, including the pricing, on an active subscription. The subscription must not be within 1 hour of its next renewal, and only one change can be pending at a time.

Access

This endpoint requires the Subscription Updates API feature flag to be enabled on your store. Contact PayNow to request access.

Proration behavior

Controlled by the proration_behavior field on the request:

  • immediate - the change is applied as soon as possible. Proration is calculated for the remaining period. If the prorated amount is ≥ $0.50 (or equivalent in other currencies), an order is initiated against the subscription's payment method; the change is applied once the payment succeeds. If the prorated amount is below $0.50, no order is created and the change is applied instantly. Only one proration order is allowed per billing cycle - a second immediate change in the same period will be rejected if a proration was already charged. When a payment is triggered, the response will include a pending_payment object. The payment result is synchronous - check pending_payment.declined to determine whether the charge succeeded. If declined, pending_payment.decline_code contains the reason.

  • next_billing_period - no payment is created. The change is queued and will be applied automatically at the start of the next renewal cycle. Ideal for downgrades.

  • none - the change is applied instantly with no proration calculated or charged.

Reverting a pending change

If a next_billing_period change is pending and the new request specifies the same product versions that are already on the subscription (i.e. reverting back to the current state), the pending change is canceled rather than rejected. The canceled change record is returned in the response.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
subscriptionIdstring · flake-idRequiredExample: 411486491630370816
Body
proration_behaviorstring · enumRequired

Describes how proration is handled when a subscription change is applied.

Possible values:
Responses
200

OK

application/json

Response returned after a subscription change is initiated.

post/v1/stores/{storeId}/subscriptions/{subscriptionId}/change
POST /v1/stores/{storeId}/subscriptions/{subscriptionId}/change HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "lines": [
    {
      "product_id": "411486491630370816",
      "product_version_id": "411486491630370816",
      "custom_variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "selected_gameserver_id": "411486491630370816"
    }
  ],
  "proration_behavior": "invalid"
}
{
  "subscription_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-01-01T00:00:00.000Z",
    "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
    }
  },
  "pending_payment": {
    "status": "text",
    "declined": true,
    "decline_message": null,
    "checkout_url": null
  }
}

Preview a subscription change

post

Simulates a subscription change and returns the pricing breakdown without creating any records or initiating a payment. Accepts the same request body as POST change — see that endpoint for full parameter documentation. Does not return the pending_payment field.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
subscriptionIdstring · flake-idRequiredExample: 411486491630370816
Body
proration_behaviorstring · enumRequired

Describes how proration is handled when a subscription change is applied.

Possible values:
Responses
200

OK

application/json

Response returned after a subscription change is initiated.

post/v1/stores/{storeId}/subscriptions/{subscriptionId}/change/preview
POST /v1/stores/{storeId}/subscriptions/{subscriptionId}/change/preview HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "lines": [
    {
      "product_id": "411486491630370816",
      "product_version_id": "411486491630370816",
      "custom_variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "selected_gameserver_id": "411486491630370816"
    }
  ],
  "proration_behavior": "invalid"
}
{
  "subscription_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-01-01T00:00:00.000Z",
    "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
    }
  },
  "pending_payment": {
    "status": "text",
    "declined": true,
    "decline_message": null,
    "checkout_url": null
  }
}
PreviousStore
NextTags

Last updated

Was this helpful?