Create Billing Agreement Alias | Welcome to cash-app Documentation

Creates an alias for an existing billing agreement to help load payment schedule widget.

Deprecated. For new integrations, see Grants.

Creates an alias for an existing billing agreement to help load payment schedule widget. *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.

tokenstringRequired

Token of the billing agreement to create an alias for

durationstringOptional

Duration of the billing agreement in ISO-8601 period format

Response

Alias created successfully

tokenstring

Token representing the billing agreement alias

expirydatetime

Timestamp when the alias token expires

Errors

403

Alias Billing Agreement Request Forbidden Error

415

Alias Billing Agreement Request Unsupported Media Type Error

$	curl -X POST https://global-api-sandbox.afterpay.com/v2/billing-agreements/alias \
>	-H "Accept: application/json" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2"
>	}'

Authentication

Headers

Request

Response

Errors