Sign in

v1

latestOpenAPI 3.1.02026-08-062951103.4 KB
subscriptions

List subscriptions

get/subscriptions

Query parameters

platform_idstring

Filter subscribers by subscription platform ID

subscriber_idstring

Filter subscriptions by subscriber ID

created_atstring

Filter subscriptions by the created_at property. Specify as a dictionary with one or more of the following properties:

  • created_at[gt] — Return subscriptions where created_at is greater than this value
  • created_at[lt] — Return subscriptions where created_at is less than this value
  • created_at[gte] — Return subscriptions where created_at is greater than or equal to this value
  • created_at[lte] — Return subscriptions where created_at is less than or equal to this value

Specify date values in ISO 8601 format.

updated_atstring

Filter subscriptions by the updated_at property. Specify as a dictionary with one or more of the following properties:

  • updated_at[gt] — Return subscriptions where updated_at is greater than this value
  • updated_at[lt] — Return subscriptions where updated_at is less than this value
  • updated_at[gte] — Return subscriptions where updated_at is greater than or equal to this value
  • updated_at[lte] — Return subscriptions where updated_at is less than or equal to this value

Specify date values in ISO 8601 format.

cursorstring

Pagination cursor to retrieve

limitinteger

Limit of subscriptions to return

Response

OK

next_cursorstring nullable

Example response

{
  "data": [
    {
      "id": "subn_dp79dRR5wIy1kGW4PCO41wit",
      "platform_id": "sub_JE1trB8eUAnh0r",
      "subscriber_id": "subr_GQmXBebvivMb5tHhassNV9kj",
      "mrr": "399.95",
      "status": "active",
      "properties": [
        {
          "property": {
            "id": "prop_S6A17y8S8wgKBBJbveQHpLW6",
            "key": "is_professional",
            "name": "Is professional",
            "type": "boolean",
            "format": "null"
          },
          "formatted_value": "True"
        }
      ]
    }
  ],
  "next_cursor": "null"
}