Referência

Estrutura

Uma sessão de checkout é representada em nossa API pela seguinte estrutura:

{
  "id": "cs_abc123xyz",
  "status": "open",
  "customerId": "cus_ahwDXrgYvur89iPs",
  "url": "https://checkout.upag.io/cs_abc123xyz",
  "billingAddressCollection": false,
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "latitude": null,
  "longitude": null,
  "country": null,
  "region": null,
  "city": null,
  "expiresAt": "2024-11-16T10:00:00.000Z",
  "createdAt": "2024-11-15T10:00:00.000Z",
  "updatedAt": "2024-11-15T10:00:00.000Z",
  "items": [
    {
      "id": "csi_abc123xyz",
      "priceId": "price_def456ghi",
      "quantity": 1,
      "price": {
        "id": "price_def456ghi",
        "name": "Plano Pro Mensal",
        "billingType": "recurring",
        "interval": "month",
        "intervalCount": 1,
        "currency": "BRL",
        "amount": 9900,
        "product": {
          "id": "prod_xyz789abc",
          "name": "Plano Pro",
          "description": null,
          "image": null
        }
      }
    }
  ]
}

Atributos:

id:

{
  "id": "cs_abc123xyz",
}

id : string.
Identificador único da sessão de checkout, começando com cs_

status:

{
  "status": "open",
}

status : string.
Status atual da sessão de checkout

Status	Descrição
`open`	A sessão está aberta e aguardando pagamento
`complete`	A sessão foi concluída com sucesso
`expired`	A sessão expirou sem pagamento

customerId:

{
  "customerId": "cus_ahwDXrgYvur89iPs",
}

customerId : string | null.
ID do cliente associado à sessão. Veja a referência completa aqui

url:

{
  "url": "https://checkout.upag.io/cs_abc123xyz",
}

url : string.
URL da página de checkout para redirecionar o cliente

billingAddressCollection:

{
  "billingAddressCollection": false,
}

billingAddressCollection : boolean.
Indica se o endereço de cobrança deve ser coletado durante o checkout

successUrl:

{
  "successUrl": "https://example.com/success",
}

successUrl : string | null.
URL para redirecionar o cliente após a conclusão bem-sucedida do pagamento

cancelUrl:

{
  "cancelUrl": "https://example.com/cancel",
}

cancelUrl : string | null.
URL para redirecionar o cliente ao cancelar ou abandonar o checkout

latitude / longitude:

{
  "latitude": null,
  "longitude": null,
}

latitude / longitude : string | null.
Coordenadas geográficas detectadas do cliente durante o checkout

country / region / city:

{
  "country": null,
  "region": null,
  "city": null,
}

country / region / city : string | null.
Localização geográfica detectada do cliente durante o checkout

expiresAt:

{
  "expiresAt": "2024-11-16T10:00:00.000Z",
}

expiresAt : string | null.
Data de expiração da sessão em formato ISO 8601

items:

{
  "items": [
    {
      "id": "csi_abc123xyz",
      "priceId": "price_def456ghi",
      "quantity": 1,
      "price": {
        "id": "price_def456ghi",
        "name": "Plano Pro Mensal",
        "billingType": "recurring",
        "interval": "month",
        "intervalCount": 1,
        "currency": "BRL",
        "amount": 9900
      }
    }
  ]
}

items : array.
Lista de itens da sessão de checkout. Cada item contém id, priceId, quantity e o objeto price expandido com detalhes do preço e produto

createdAt:

{
  "createdAt": "2024-11-15T10:00:00.000Z",
}

createdAt : string.
Data de criação da sessão em formato ISO 8601

updatedAt:

{
  "updatedAt": "2024-11-15T10:00:00.000Z",
}

updatedAt : string.
Data da última atualização da sessão em formato ISO 8601

Primeiros passos

Clientes

Métodos de Pagamento

Pagamentos

Sessões de Checkout

Faturas

Assinaturas

Webhooks

Estrutura

Atributos:

​ Estrutura

​Atributos:

Estrutura

Atributos: