Skip to navigation
ReferenceBilling Agreements (Deprecated)

Create Billing Agreement Alias

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

Deprecated. For new integrations, see Grants.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Request

The request containing the billing agreement token and optional duration
tokenstringRequired
Token of the billing agreement to create an alias for
durationstring or nullOptionalformat: "duration"

Duration of the billing agreement in ISO-8601 period format

Response

Alias created successfully
tokenstring
Token representing the billing agreement alias
expirystringformat: "date-time"
Timestamp when the alias token expires

Errors

403
Forbidden Error
415
Unsupported Media Type Error