Skip to main content
Retorna uma lista paginada de todas as assinaturas. Pode ser filtrada por cliente ou status.

​
Endpoint

cURL
curl -G https://api.upag.io/v1/subscriptions \
  -H "Authorization: Bearer {token}" \
  -d page=1 \
  -d limit=10 \
  -d customer=cus_ahwDXrgYvur89iPs

​
Parâmetros

​
limit
integer
Limita o número de assinaturas retornadas. Padrão: 10, máximo: 100.
​
page
integer
Número da página a ser retornada. Padrão: 1.
​
id
string
Filtra por ID da assinatura (sub_...).
​
customer
string
ID do cliente (cus_...) para filtrar assinaturas desse cliente. O nome do parâmetro na query é customer.
​
status
string
Filtra assinaturas por status: active, trialing, past_due, canceled, unpaid, incomplete.
​
cancelAtPeriodEnd
boolean
Quando true ou false, filtra assinaturas com esse valor de cancelAtPeriodEnd. Envie como string true ou false na query.

​
Resposta

Response
{
  "data": [
    {
      "id": "sub_abc123xyz",
      "livemode": false,
      "customerId": "cus_ahwDXrgYvur89iPs",
      "paymentMethodId": "pm_abc123xyz",
      "status": "active",
      "currency": "BRL",
      "interval": "month",
      "intervalCount": 1,
      "cancelAtPeriodEnd": false,
      "startDate": "2024-11-15T10:00:00.000Z",
      "endDate": null,
      "trialStartDate": null,
      "trialEndDate": null,
      "currentPeriodStart": "2024-11-15T10:00:00.000Z",
      "currentPeriodEnd": "2024-12-15T10:00:00.000Z",
      "canceledAt": null,
      "cancellationReason": null,
      "items": [
        {
          "id": "si_abc123xyz",
          "subscriptionId": "sub_abc123xyz",
          "productId": "prod_xyz789abc",
          "priceId": "price_def456ghi",
          "name": "Plano Pro",
          "amount": 9900,
          "quantity": 1,
          "createdAt": "2024-11-15T10:00:00.000Z",
          "updatedAt": "2024-11-15T10:00:00.000Z"
        }
      ],
      "createdAt": "2024-11-15T10:00:00.000Z",
      "updatedAt": "2024-11-15T10:00:00.000Z"
    }
  ],
  "total": 1
}