Subscriptions

Get subscriptions

get

Retrieves all subscriptions for the specified store.

Authorizations
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
get
/v1/stores/{storeId}/subscriptions
GET /v1/stores/{storeId}/subscriptions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "store_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-10-30T00:43:40.771Z",
      "updated_at": "2025-10-30T00:43:40.771Z",
      "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"
    },
    "status": "created",
    "coupon_id": "411486491630370816",
    "coupon_repeating_ends_at": "2025-10-30T00:43:40.771Z",
    "affiliate_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "billing_name": "text",
    "billing_email": "text",
    "billing_country": "text",
    "tax_jurisdictions": [
      {
        "name": "EU OSS",
        "taxes": [
          {
            "tax_name": "text",
            "taxable_amount": "text",
            "tax_amount": "text",
            "tax_rate": "text"
          }
        ],
        "not_taxed_reason": "text"
      }
    ],
    "customer_ip": "text",
    "gift": true,
    "gift_to_customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-10-30T00:43:40.771Z",
      "updated_at": "2025-10-30T00:43:40.771Z",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "product_name": "text",
    "product_image_url": "text",
    "interval_value": 1,
    "interval_scale": "invalid",
    "currency": "text",
    "tax_inclusive": true,
    "price": 1,
    "price_str": "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",
    "pricing_region_id": "text",
    "current_period_start": "2025-10-30T00:43:40.771Z",
    "current_period_end": "2025-10-30T00:43:40.771Z",
    "billing_cycle_sequence": 1,
    "next_attempt_at": "2025-10-30T00:43:40.771Z",
    "attempt_count": 1,
    "created_at": "2025-10-30T00:43:40.771Z",
    "updated_at": "2025-10-30T00:43:40.771Z",
    "active_at": "2025-10-30T00:43:40.771Z",
    "canceled_at": "2025-10-30T00:43:40.771Z",
    "cancel_reason": "text"
  }
]

Get subscription by ID

get

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

Authorizations
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
get
/v1/stores/{storeId}/subscriptions/{subscriptionId}
GET /v1/stores/{storeId}/subscriptions/{subscriptionId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "pretty_id": "text",
  "store_id": "411486491630370816",
  "customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": "text"
    },
    "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": "text",
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2025-10-30T00:43:40.771Z",
    "updated_at": "2025-10-30T00:43:40.771Z",
    "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"
  },
  "status": "created",
  "coupon_id": "411486491630370816",
  "coupon_repeating_ends_at": "2025-10-30T00:43:40.771Z",
  "affiliate_id": "411486491630370816",
  "checkout_id": "411486491630370816",
  "checkout_line_id": "411486491630370816",
  "billing_name": "text",
  "billing_email": "text",
  "billing_country": "text",
  "tax_jurisdictions": [
    {
      "name": "EU OSS",
      "taxes": [
        {
          "tax_name": "text",
          "taxable_amount": "text",
          "tax_amount": "text",
          "tax_rate": "text"
        }
      ],
      "not_taxed_reason": "text"
    }
  ],
  "customer_ip": "text",
  "gift": true,
  "gift_to_customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": "text"
    },
    "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": "text",
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2025-10-30T00:43:40.771Z",
    "updated_at": "2025-10-30T00:43:40.771Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "product_id": "411486491630370816",
  "product_version_id": "411486491630370816",
  "product_name": "text",
  "product_image_url": "text",
  "interval_value": 1,
  "interval_scale": "invalid",
  "currency": "text",
  "tax_inclusive": true,
  "price": 1,
  "price_str": "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",
  "pricing_region_id": "text",
  "current_period_start": "2025-10-30T00:43:40.771Z",
  "current_period_end": "2025-10-30T00:43:40.771Z",
  "billing_cycle_sequence": 1,
  "next_attempt_at": "2025-10-30T00:43:40.771Z",
  "attempt_count": 1,
  "created_at": "2025-10-30T00:43:40.771Z",
  "updated_at": "2025-10-30T00:43:40.771Z",
  "active_at": "2025-10-30T00:43:40.771Z",
  "canceled_at": "2025-10-30T00:43:40.771Z",
  "cancel_reason": "text"
}

Cancel subscription by ID

post

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

Authorizations
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
Responses
204

No Content

No content
post
/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel
POST /v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousSalesNextTags

Was this helpful?