ABabacatepay

Deletar um checkout de assinatura

Changed on

Exclui um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), que deixa de aparecer nas listagens.

As assinaturas que o checkout já gerou continuam ativas. Para encerrá-las, use POST /subscriptions/cancel.

post/subscriptions/checkouts/delete

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/subscriptions/checkouts/delete
  • Auth
    HTTP bearer

Query parameters

idstring required
Example:bill_abc123xyz

Identificador único do checkout de assinatura

Response

Checkout de assinatura excluído com sucesso.

errorstring nullable
successboolean

Se a requisição obteve sucesso ou não.

Example response

{
  "data": {
    "id": "bill_abc123xyz",
    "externalId": "pedido-123",
    "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
    "amount": 10000,
    "items": [
      {
        "id": "prod_456",
        "quantity": 2
      }
    ],
    "status": "PENDING",
    "coupons": [],
    "upSellProductId": "prod_bump456xyz",
    "installmentsCount": 3,
    "card": {
      "maxInstallments": 12
    },
    "dueDate": "2026-08-15",
    "interest": {
      "value": 100
    },
    "fine": {
      "value": 200,
      "type": "PERCENTAGE"
    },
    "metadata": {},
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "success": true
}

Changes

  • 319122d4f5fcRevision changes
    • warning

      added the new REDEEMED enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f72547ee8530Revision changes
    • info

      endpoint added