Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.upag.io/llms.txt

Use this file to discover all available pages before exploring further.

Cria uma nova assinatura recorrente para um cliente. Moeda e intervalo de cobrança vêm dos preços dos itens (todos os preços devem ser recorrentes e compartilhar o mesmo intervalo e moeda). Se trialEnd for informado, a assinatura entra em trialing e a cobrança inicial não é processada; caso contrário, a primeira fatura é gerada e o pagamento é tentado na hora.

​
Endpoint

cURL
curl -X POST https://api.upag.io/v1/subscriptions \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": "cus_ahwDXrgYvur89iPs",
    "paymentMethod": "pm_abc123xyz",
    "items": [
      {
        "price": "price_def456ghi",
        "quantity": 1
      }
    ]
  }'

​
Parâmetros

​
customer
string
required
ID do cliente (cus_...) para quem a assinatura será criada.
​
paymentMethod
string
required
ID do método de pagamento (pm_...) usado nas cobranças.
​
items
array
required
Lista de itens. Cada item deve conter price (ID do preço recorrente) e quantity (inteiro, mínimo 1).
​
trialEnd
integer
Opcional. Timestamp numérico inteiro positivo indicando o fim do período de teste. Quando presente, a assinatura é criada como trialing e não há cobrança inicial neste request.

​
Resposta

Response
{
  "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"
}