Get Billing Agreement Details

Retrieves the details of a billing agreement using its token.

Deprecated. For new integrations, see Grants.

get/v2/billing-agreements/{token}

Request

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

Path parameters

tokenstring required

The unique identifier token of the billing agreement to retrieve

Headers

User-Agentstring required

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.