Skip to main content
GET
/
subscriptions
List Subscriptions
curl --request GET \
  --url https://api.atlas.co/functions/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "subscription",
      "customer": "<string>",
      "status": "trialing",
      "current_period_start": 123,
      "current_period_end": 123,
      "trial_start": 123,
      "trial_end": 123,
      "cancel_at_period_end": true,
      "canceled_at": 123,
      "ended_at": 123,
      "collection_method": "<string>",
      "days_until_due": 123,
      "default_payment_method": "<string>",
      "items": {
        "object": "list",
        "data": [
          {
            "id": "<string>",
            "object": "subscription_item",
            "price": {
              "id": "<string>",
              "product": "<string>",
              "unit_amount": 123,
              "currency": "<string>",
              "recurring": {
                "interval": "<string>",
                "interval_count": 123
              }
            },
            "quantity": 123,
            "created": 123
          }
        ]
      },
      "latest_invoice": "<string>",
      "metadata": {},
      "created": 123
    }
  ],
  "has_more": true,
  "total_count": 123
}

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Query Parameters

limit
integer
default:10
Required range: x <= 100
offset
integer
default:0
customer
string
status
enum<string>
Available options:
trialing,
active,
past_due,
paused,
canceled,
unpaid

Response

200 - application/json

Subscription list

object
enum<string>
Available options:
list
data
object[]
has_more
boolean
total_count
integer