Start Billing Agreement Link Flow

POST

/v2/billing-agreements/start

Initiates the headless billing agreement link flow process.

Deprecated. For new integrations, see Grants.

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)>.

Request

This endpoint expects an object.

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

expiresAtdatetime

When this link attempt will expire

deliveryTypeenum

How the verification code was delivered to the consumer

Errors

404

Start Billing Agreement Link Request Not Found Error

412

Start Billing Agreement Link Request Precondition Failed Error

429

Start Billing Agreement Link Request Too Many Requests Error

$	curl -X POST https://global-api-sandbox.afterpay.com/v2/billing-agreements/start \
>	-H "Accept: application/json" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"alias": "my-afterpay-email@gmail.com",
>	"requestId": "123e4567-e89b-12d3-a456-426614174000"
>	}'

1	{
2	"token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
3	"requestId": "123e4567-e89b-12d3-a456-426614174000",
4	"expiresAt": "2025-03-22T12:00:00Z",
5	"deliveryType": "SMS"
6	}

Authentication

Headers

Request

Response

Errors