Tier Groups

Get customer tier groups

get

Retrieves tier group state for a logged in customer. Returns an empty array if not logged in.

Authorizations

Customer

AuthorizationstringOptional

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

Responses

200

OK

application/json

tier_group_idstring · flake-idRequiredExample: 411486491630370816

active_product_idstring · flake-idRequiredExample: 411486491630370816

pending_change_product_idstring · flake-idOptionalExample: 411486491630370816

next_renewal_atstring · date-timeRequired

The date and time of the next subscription renewal for this tier group.

next_billing_amountinteger · int64Required

The next billing amount in the smallest currency unit (e.g., cents) in the settlement currency.

next_billing_presentment_amountinteger · int64Required

The next billing amount in the smallest currency unit (e.g., cents) in the customer-facing presentment currency.

currencystringRequired

The settlement currency code (e.g., "usd").

presentment_currencystringRequired

The customer-facing presentment currency code (e.g., "eur").

default

Error response

application/json

get/v1/store/tier-groups

HTTPcURLJavaScriptPython

GET /v1/store/tier-groups HTTP/1.1
Authorization: Customer TOKEN_HERE
Accept: */*

[
  {
    "tier_group_id": "411486491630370816",
    "active_product_id": "411486491630370816",
    "pending_change_product_id": "411486491630370816",
    "next_renewal_at": "2026-08-08T14:24:39.272Z",
    "next_billing_amount": 1,
    "next_billing_presentment_amount": 1,
    "currency": "text",
    "presentment_currency": "text"
  }
]

Update subscription tier group

post

Upgrades or downgrades an existing subscription tier group. The customer must have an active subscription within this tier group.

Authorizations

Customer

AuthorizationstringRequired

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

Path parameters

idstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

target_product_idstring · flake-idRequiredExample: 411486491630370816

verification_codestring · nullableOptional

A verification code sent to the customer's subscription billing e-mail. Pass this if the status field on the subscription_change object equals pending_verification.

Responses

200

OK

application/json

Response returned after a subscription change is initiated.

default

Error response

application/json

post/v1/store/tier-groups/{id}/change

HTTPcURLJavaScriptPython

POST /v1/store/tier-groups/{id}/change HTTP/1.1
Authorization: Customer TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "target_product_id": "411486491630370816",
  "verification_code": null
}

application/jsontext/jsonapplication/*+json

{
  "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-08-08T14:24:39.272Z",
    "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 update subscription tier group

post

Previews an upgrade or a downgrade an existing subscription tier group. The customer must have an active subscription within this tier group.

Authorizations

Customer

AuthorizationstringRequired

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

Path parameters

idstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

target_product_idstring · flake-idRequiredExample: 411486491630370816

verification_codestring · nullableOptional

A verification code sent to the customer's subscription billing e-mail. Pass this if the status field on the subscription_change object equals pending_verification.

Responses

200

OK

application/json

Response returned after a subscription change is initiated.

default

Error response

application/json

post/v1/store/tier-groups/{id}/change/preview

HTTPcURLJavaScriptPython

POST /v1/store/tier-groups/{id}/change/preview HTTP/1.1
Authorization: Customer TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "target_product_id": "411486491630370816",
  "verification_code": null
}

application/jsontext/jsonapplication/*+json

{
  "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-08-08T14:24:39.272Z",
    "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
  }
}