Retrieve Billing Agreement

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.

post/v2/billing-agreements/retrieve

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v2/billing-agreements/retrieve
  • Auth: HTTP basic

Headers

User-Agentstring required

Request body

tokenstring required

The billing agreement token to retrieve

Response

Billing agreement details retrieved successfully

tokenstring required

Unique token identifying the agreement

type'BILLING' required

Type of agreement

status'ACTIVE' | 'CANCELLED' | 'EXPIRED' | 'PENDING_RENEWAL' | 'PENDING_RENEWAL_EXPIRED' required

Current status of the agreement

merchantReferencestring

Merchant's reference for this agreement

createdstring date-time required

Timestamp when the agreement was created

cancelledstring date-time

If present, indicates when the agreement was cancelled

expiresstring date-time

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

requestIdstring

Unique identifier for the request

consumerReferencestring

Reference identifier for the consumer

emailstring

Masked email address of the consumer

Changes

No recorded changes to this operation across all 1 revision of this API.