ReferenceBilling Agreements (Deprecated)

Start Billing Agreement Link Flow

Initiates the headless billing agreement link flow process. *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)>.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Request

The request containing the details needed to start the billing agreement link flow
aliasstringRequired
Email or phone number associated with the consumer's afterpay account
requestIdstringRequired
A unique identifier for this request

Response

Link flow started successfully
tokenstring
Token identifying the billing agreement to be created
requestIdstring
The unique identifier from the request
expiresAtstringformat: "date-time"
When this link attempt will expire
deliveryTypeenum
How the verification code was delivered to the consumer
Allowed values:

Errors

404
Not Found Error
412
Precondition Failed Error
429
Too Many Requests Error