Skip to main content
GET
/
v1
/
account_collection_subscriptions
List all account collection subscriptions
curl --request GET \
  --url https://api.yorlet.com/v1/account_collection_subscriptions \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "account_collection_subscription",
      "account_collection_data": {
        "amount": 2,
        "currency": "gbp",
        "description": "<string>",
        "destination": "<string>",
        "expense": {
          "description": "<string>"
        },
        "fee": {
          "discount": 50
        },
        "tax_percent": 50,
        "unit": "<string>",
        "workspace": "<string>"
      },
      "billing_cycles": 123,
      "interval_count": 123,
      "last_account_collection_error": {
        "message": "<string>",
        "type": "<string>"
      },
      "next_collection_date": 123,
      "next_period_end": 123,
      "next_period_start": 123,
      "owner": "<string>",
      "start_date": 123,
      "timezone": "<string>",
      "account": "<string>",
      "deleted": false,
      "billing_cycles_count": 0,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of account collection 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