List subscriptions

Return subscriptions for the authenticated account or product scope.

Last updated

Author: AtomicPay API

Authentication

Send your AtomicPay developer API key using Authorization: Bearer <API_KEY> or X-API-Key: <API_KEY>. This endpoint requires subscriptions.read permission, unless the key has wildcard access (*).

Query parameters

limit

Optional. Defaults to 20 and is capped at 100.

status

Optional. Filter by subscription status, such as active, canceled, or trial.

customer_id

Optional. Filter subscriptions by customer ID.

GET/v1/subscriptions

Base URL: https://api.atomicpay.com.br

Return subscriptions for the authenticated account or product scope.

Request examples

curl

curl "https://api.atomicpay.com.br/v1/subscriptions?status=active" \
  -H "Authorization: Bearer {{api_key}}"

request.js

const response = await fetch('https://api.atomicpay.com.br/v1/subscriptions?status=active', {
  method: 'GET',
  headers: { Authorization: 'Bearer {{api_key}}' },
});

const data = await response.json();

Response

response.json

{
  "object": "list",
  "data": [
    {
      "id": "sub_123",
      "object": "subscription",
      "status": "active",
      "customer": { "id": "cus_123", "name": "Jenny Rosen", "email": "jenny@example.com" },
      "product": { "id": "prod_123", "name": "Starter" },
      "plan": { "code": "starter", "name": "Starter" },
      "offer": { "code": "monthly", "value": 1000, "period": "monthly" },
      "payment_method": "credit_card",
      "date_next_charge": 1767000000000,
      "current_cycle": 2,
      "originated_from": "checkout",
      "created_at": 1766400000000
    }
  ],
  "has_more": false,
  "total_count": 1
}

Retrieve a product

Retrieve one product by ID.

Retrieve a subscription

Retrieve one subscription by ID.