Subscriptions
Retrieves all subscriptions for the specified store.
The ID of the store to retrieve subscriptions for.
411486491630370816
411486491630370816
411486491630370816
411486491630370816
411486491630370816
411486491630370816
The maximum number of items to return in a single request.
Returns items after the specified ID. Used for forward pagination through results.
Returns items before the specified ID. Used for backward pagination through results.
Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
OK
Error response
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-08-22T18:21:34.733Z",
"updated_at": "2025-08-22T18:21:34.733Z",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"payment_method_id": "411486491630370816",
"status": "created",
"coupon_id": "411486491630370816",
"coupon_repeating_ends_at": "2025-08-22T18:21:34.733Z",
"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-08-22T18:21:34.733Z",
"updated_at": "2025-08-22T18:21:34.733Z",
"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-08-22T18:21:34.733Z",
"current_period_end": "2025-08-22T18:21:34.733Z",
"billing_cycle_sequence": 1,
"next_attempt_at": "2025-08-22T18:21:34.733Z",
"attempt_count": 1,
"created_at": "2025-08-22T18:21:34.733Z",
"updated_at": "2025-08-22T18:21:34.733Z",
"active_at": "2025-08-22T18:21:34.733Z",
"canceled_at": "2025-08-22T18:21:34.733Z",
"cancel_reason": "text"
}
]
Retrieves a subscription for the specified store by the supplied ID.
The ID of the store to retrieve the subscription for.
411486491630370816
The ID of the subscription.
411486491630370816
OK
Error response
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-08-22T18:21:34.733Z",
"updated_at": "2025-08-22T18:21:34.733Z",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"payment_method_id": "411486491630370816",
"status": "created",
"coupon_id": "411486491630370816",
"coupon_repeating_ends_at": "2025-08-22T18:21:34.733Z",
"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-08-22T18:21:34.733Z",
"updated_at": "2025-08-22T18:21:34.733Z",
"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-08-22T18:21:34.733Z",
"current_period_end": "2025-08-22T18:21:34.733Z",
"billing_cycle_sequence": 1,
"next_attempt_at": "2025-08-22T18:21:34.733Z",
"attempt_count": 1,
"created_at": "2025-08-22T18:21:34.733Z",
"updated_at": "2025-08-22T18:21:34.733Z",
"active_at": "2025-08-22T18:21:34.733Z",
"canceled_at": "2025-08-22T18:21:34.733Z",
"cancel_reason": "text"
}
Cancels a subscription for the specified store by the supplied ID.
The ID of the store to cancel the subscription for.
411486491630370816
The ID of the subscription.
411486491630370816
No Content
Error response
POST /v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Was this helpful?