Players' Subscriptions

Get Subscriptions

Changed on

Retrieve subscriptions for a player.

get/v1/players/{player_id}/subscriptions

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/players/{player_id}/subscriptions
  • Auth
    HTTP bearer

Path parameters

player_idstring required

Query parameters

effectiveboolean

Filter by effective status. True for effective only, False for non-effective only, None for all.

limitinteger

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

Response

Successful Response

skustring required

Subscription unique SKU.

idstring required

Unique identifier for this subscription instance. Use this ID to track and manage the subscription throughout its lifecycle.

namestring required

Subscription display name.

order_idstring required

Order ID where the subscription was originally activated. Use this to correlate with order webhooks.

status'trial' | 'active' | 'grace' | 'canceled' | 'locked' | 'ended' | 'expired' | 'paused' | 'pending' required
created_atinteger required

Subscription creation date in Unix epoch time (seconds).

updated_atinteger

Subscription last update date in Unix epoch time (seconds). Null if the subscription has not been updated.

effective_untilinteger

The date until which the subscription is effective in Unix epoch time (seconds) representing when the subscription benefits should remain accessible.

metadataobject

Custom key-value pairs attached to the subscription. Null if no metadata is set.

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • fb9750c99d0aRevision changes
    • warning

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

    • warning

      for the query request parameter limit, the max was set to 300.00

    • warning

      for the query request parameter offset, the min was set to 0.00