ReferenceBilling Agreements (Deprecated)

Start Billing Agreement Approval Process

Initiates the approval process for a new billing agreement. *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 billing agreement approval request details
merchantobjectRequired
consumerobjectOptional
Consumer details for the billing agreement
merchantReferencestringOptional<=128 characters
Merchant's unique reference for this billing agreement
agreementslist of objectsOptional

Agreement type for approval (only single agreement is supported)

Response

The consumer approved the billing agreement
tokenstring
Token identifying this billing agreement approval request
expiresstringformat: "date-time"
When this approval request expires
redirectCheckoutUrlstringformat: "uri"
URL where the consumer should be redirected to complete approval

Errors

401
Unauthorized Error
403
Forbidden Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error