Retrieve a subscription

Retrieve one subscription by ID.

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 (*).

Path parameters

id

Required. AtomicPay subscription ID.

GET/v1/subscriptions/:id

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

Retrieve one subscription by ID.

Request examples

curl

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

request.js

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

const data = await response.json();

Response

response.json

{
  "id": "sub_123",
  "object": "subscription",
  "status": "active",
  "status_reason": null,
  "status_date": 1766400000000,
  "customer": { "id": "cus_123", "name": "Jenny Rosen", "email": "jenny@example.com" },
  "product": { "id": "prod_123", "name": "Starter" },
  "plan": { "code": "starter", "name": "Starter", "type": "recurring" },
  "offer": { "code": "monthly", "value": 1000, "period": "monthly", "trial": false },
  "payment_method": "credit_card",
  "date_next_charge": 1767000000000,
  "current_cycle": 2,
  "charges": [{ "id": "charge_123", "date": 1766400000000 }],
  "originated_from": "checkout",
  "created_at": 1766400000000
}

List subscriptions

Return subscriptions for the authenticated account or product scope.

Cancel a subscription

Cancel an active subscription and store the cancellation reason.