Skip to main content
GET
/
v1
/
subscriptions
List all subscriptions
curl --request GET \
  --url https://api.yorlet.com/v1/subscriptions \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "subscription",
      "application": "<string>",
      "billing_anchor": 123,
      "billing_anchor_config": {
        "day_of_month": 16
      },
      "cancel_at": 123,
      "canceled_at": 123,
      "collection_method": "charge_automatically",
      "coupon": "<string>",
      "currency": "gbp",
      "current_period_end": 123,
      "current_period_start": 123,
      "custom_fields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "customer": "<string>",
      "days_before_collection": 3,
      "days_until_due": 1,
      "default_payment_method": "<string>",
      "description": "<string>",
      "end": 123,
      "interval": "month",
      "interval_count": 123,
      "next_period_end": 123,
      "next_period_start": 123,
      "pause_collection": {
        "behavior": "draft",
        "resumes_at": 123
      },
      "payment_settings": {
        "payment_method_types": [
          "autogiro"
        ]
      },
      "phases": [
        {
          "start_date": 123,
          "items": [
            "<unknown>"
          ]
        }
      ],
      "start": 123,
      "status": "active",
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A list object with a data property that contains an array of subscriptions.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required