Retrieve Billing Agreement | Welcome to cash-app Documentation

curl -X POST https://global-api-sandbox.afterpay.com/v2/billing-agreements/retrieve \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "token": "ba_jkl012mno345"
}'

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

Alternative endpoint to retrieve billing agreement details using a request body instead of path parameter. Functionally equivalent to GET /v2/billing-agreements/{token}.

Deprecated. For new integrations, see Grants.

Alternative endpoint to retrieve billing agreement details using a request body instead of path parameter. Functionally equivalent to GET /v2/billing-agreements/{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)>.

Request

This endpoint expects an object.

tokenstringRequired

The billing agreement token to retrieve

Response

Billing agreement details retrieved 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

Retrieve Billing Agreement Request Forbidden Error

404

Retrieve Billing Agreement Request Not Found Error

Authentication

Headers

Request

Response

Errors