Sign in

v1

latestOpenAPI 3.0.02026-08-06363576.8 KB
Subscription

Get all subscriptions

get/subscriptions/

Query parameters

page_sizeinteger

The number of items to return in the response. Default is 10, maximum is 1000. This parameter is optional, and if it is not present in the query string, no pagination is applied.

typestring

The type of response returned. Valid values are light, full. Default is full. This parameter is optional, and if it is not present in the query string, the full response is returned.

orderingstring

The ordering of records returned in response. Valid values are active_until (ascending), -active_until (descending), start_date (ascending), -start_date (descending). This parameter is optional, and if it is not present in the query string, the unordered response is returned.

Response

Successful operation

OR

Example response

[
  {
    "id": 123,
    "reference": "REF-12345",
    "token": "637302f0412e2e11adc0ba21adafcf11",
    "customer": 123,
    "plan": {
      "id": 1,
      "name": "Name of the plan.",
      "alternative_name": "A slightly longer name or more descriptive.",
      "reference": "SKU-1",
      "interval": "day|week|month|year",
      "interval_count": 1,
      "amount": "1.0000",
      "currency": "USD",
      "description": "A longer description.",
      "enabled": true,
      "electronic_only": true,
      "payment_processor": {
        "id": 1,
        "name": "Adyen processor",
        "type": "adyen"
      }
    },
    "billing_logs": [
      {
        "total": "6.99",
        "transaction": {
          "amount": "6.99",
          "currency": "USD"
        }
      }
    ]
  }
]