Skip to main content
GET
/
v1
/
checkout_sessions
List all checkout sessions
curl --request GET \
  --url https://api.yorlet.com/v1/checkout_sessions \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "checkout_session",
      "completed_at": 123,
      "consent_collection": {
        "terms_of_service": true
      },
      "custom_text": {
        "terms_of_service": {
          "message": "<string>"
        }
      },
      "currency": "gbp",
      "customer": "<string>",
      "default_payment_method": "<string>",
      "description": "<string>",
      "payment_method_types": [
        "<string>"
      ],
      "return_url": "<string>",
      "subscription_data": {
        "add_invoice_items": [
          {
            "amount": 123,
            "currency": "<string>",
            "description": "<string>",
            "tax_percent": 50,
            "metadata": {},
            "price": "<string>",
            "tax_rate": "<string>",
            "transfer_destination": "<string>",
            "unit": "<string>"
          }
        ],
        "billing_anchor": 123,
        "billing_anchor_config": {
          "day_of_month": 16
        },
        "coupon": "<string>",
        "custom_fields": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "days_before_collection": 3,
        "days_until_due": 1,
        "description": "<string>",
        "end_date": 123,
        "end_date_config": {
          "day": 16,
          "month": 6,
          "year": 123
        },
        "metadata": {},
        "phases": [
          {
            "start_date": 123,
            "items": [
              {
                "price_data": {
                  "amount": 123,
                  "currency": "<string>",
                  "tax_percent": 123
                },
                "description": "<string>",
                "metadata": {},
                "price": "<string>",
                "schedule": [
                  {
                    "amount": 123,
                    "effective_at": 123,
                    "effective_at_config": {
                      "day": 16,
                      "month": 6,
                      "year": 123
                    }
                  }
                ],
                "tax_rate": "<string>",
                "transfer_destination": "<string>",
                "unit": "<string>"
              }
            ]
          }
        ],
        "start_date": 123,
        "start_date_config": {
          "day": 16,
          "month": 6,
          "year": 123
        },
        "application": "<string>",
        "interval_count": 123,
        "invoice_settings": {
          "custom_fields": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        },
        "items": [
          {
            "price_data": {
              "amount": 123,
              "currency": "<string>",
              "tax_percent": 123
            },
            "description": "<string>",
            "metadata": {},
            "price": "<string>",
            "schedule": [
              {
                "amount": 123,
                "effective_at": 123,
                "effective_at_config": {
                  "day": 16,
                  "month": 6,
                  "year": 123
                }
              }
            ],
            "tax_rate": "<string>",
            "transfer_destination": "<string>",
            "unit": "<string>"
          }
        ],
        "use_future_billing_date": true
      },
      "subscription": "<string>",
      "url": "<string>",
      "account": "<string>",
      "deleted": false,
      "merchant": {
        "business_name": "<string>",
        "color": "<string>",
        "country": "<string>",
        "display_name": "<string>",
        "icon": "<string>",
        "id": "<string>",
        "support_email": "<string>",
        "support_phone": "<string>",
        "support_website": "<string>",
        "terms_of_service_url": "<string>"
      },
      "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 checkout sessions.

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