Cancel Billing Agreement | Welcome to cash-app Documentation

{
  "token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
  "type": "BILLING",
  "status": "ACTIVE",
  "created": "2024-03-04T12:00:00Z",
  "merchantReference": "merchant_ref_123",
  "cancelled": "2024-03-05T12:00:00Z",
  "expires": "2025-03-04T12:00:00Z",
  "events": [
    {
      "type": "CAPTURE",
      "created": "2024-03-04T10:30:00Z",
      "amount": {
        "amount": "100.00",
        "currency": "AUD"
      },
      "status": "APPROVED",
      "merchantReference": "merchant-event-ref-789",
      "orderId": 123
    }
  ],
  "requestId": "req_abc123def456",
  "consumerReference": "cust_12345",
  "email": "j***@e***.com"
}

Cancels an existing billing agreement using its token.

Deprecated. For new integrations, see Grants.

Cancels an existing billing agreement using its token. *Deprecated. For new integrations, see [Grants](https://afterpay.docs.buildwithfern.com/afterpay-online-developer/api-reference/reference/grants/start-grant-approval).*

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

tokenstringRequired

The unique identifier token of the billing agreement to cancel

Response

Billing agreement cancelled successfully

tokenstring

Unique token identifying the agreement

type"BILLING"

Type of agreement

statusenum

Current status of the agreement

createddatetime

Timestamp when the agreement was created

merchantReferencestringOptional

Merchant's reference for this agreement

cancelleddatetimeOptional

If present, indicates when the agreement was cancelled

expiresdatetimeOptional

If present, indicates when the agreement's status will become EXPIRED, preventing a client from using it to create payments

eventslist of objectsOptional

List of events associated with this agreement

requestIdstringOptional

Unique identifier for the request

consumerReferencestringOptional

Reference identifier for the consumer

emailstringOptional

Masked email address of the consumer

Errors

403

Cancel Billing Agreement Body Forbidden Error

404

Cancel Billing Agreement Body Not Found Error

$	curl -X DELETE https://global-api-sandbox.afterpay.com/v2/billing-agreements/token \
>	-u "<username>:<password>"

Authentication

Path parameters

Headers

Response

Errors