Retrieve Billing Agreement | Welcome to Afterpay Documentation

curl -X POST https://global-api-sandbox.afterpay.com/v2/billing-agreements/retrieve \
     -H "User-Agent: User-Agent" \
     -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

The request containing the billing agreement token to retrieve

tokenstringRequired

The billing agreement token to retrieve

Response

Billing agreement details retrieved successfully

tokenstring

Unique token identifying the agreement

typeenum

Type of agreement

Allowed values:

statusenum

Current status of the agreement

Allowed values:

createdstringformat: "date-time"

Timestamp when the agreement was created

merchantReferencestring or null

Merchant's reference for this agreement

cancelledstringformat: "date-time"

If present, indicates when the agreement was cancelled

expiresstringformat: "date-time"

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

eventslist of objects

List of events associated with this agreement

requestIdstring or null

Unique identifier for the request

consumerReferencestring or null

Reference identifier for the consumer

emailstring or null

Masked email address of the consumer

Errors

403

Forbidden Error

404

Not Found Error

Authentication

Headers

Request

Response

Errors