Sign in
Subscriptions API

List all subscriptions

Retrieve all subscriptions initiated across all your customers.

The results are paginated.

get/v2/subscriptions

Query parameters

fromstring nullable

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

profileIdstring nullable
Example:pfl_QkEhN94Ba

The identifier referring to the profile you wish to retrieve subscriptions for.

Most API credentials are linked to a single profile. In these cases the profileId is already implied.

To retrieve all subscriptions across the organization, use an organization-level API credential and omit the profileId parameter.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of subscription objects.

Changes

Changed in 5 of the 78 revisions of this API.117

  • 1bcb76dbe9ea1See the full diff
    • ▲

      the response property's min was decreased from 1.00 to 0.00 for the response status

      response-property-min-decreased

  • 00fb770ca93410See the full diff
    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

    • ○

      the response property /////// became required for the status

      response-property-became-required

  • 327472893a894See the full diff
    • ○

      the response property ///////// became required for the status

      response-property-became-required

    • ○

      the response property ///////// became required for the status

      response-property-became-required

    • ○

      the response property ///////// became required for the status

      response-property-became-required

    • ○

      the response property ///////// became required for the status

      response-property-became-required

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 78 revisions, 9 have no diff computed.