Start Billing Agreement Link Flow

Initiates the headless billing agreement link flow process.

Deprecated. For new integrations, see Grants.

post/v2/billing-agreements/start

Request

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

Headers

User-Agentstring required
Accept'application/json' required

Request body

aliasstring required

Email or phone number associated with the consumer's afterpay account

requestIdstring required

A unique identifier for this request

Response

Link flow started successfully

tokenstring required

Token identifying the billing agreement to be created

requestIdstring required

The unique identifier from the request

expiresAtstring date-time required

When this link attempt will expire

deliveryType'SMS' | 'EMAIL' required

How the verification code was delivered to the consumer

Changes

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