Skip to main content
GET
/
v1
/
subscription_items
List all subscription items
curl --request GET \
  --url https://api.yorlet.com/v1/subscription_items \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "subscription_item",
      "description": "<string>",
      "price": "<string>",
      "price_data": {
        "amount": 123,
        "currency": "gbp",
        "recurring": {
          "interval": "<string>",
          "interval_count": 123
        },
        "tax_percent": 123,
        "type": "recurring"
      },
      "schedule": [
        {
          "amount": 123,
          "effective_at": 123
        }
      ],
      "subscription": "<string>",
      "tax_rate": "<string>",
      "transfer_behavior": "automatic",
      "transfer_destination": "<string>",
      "type": "charge",
      "unit": "<string>",
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

List all subscription items

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