Create Billing Agreement | Welcome to cash-app Documentation

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

{
  "token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
  "type": "BILLING",
  "status": "ACTIVE",
  "created": "2024-03-04T12:00:00Z",
  "merchantReference": "merchant_ref_123",
  "cancelled": "2024-03-05T12:00:00Z",
  "expires": "2025-03-04T12:00:00Z",
  "events": [
    {
      "type": "CAPTURE",
      "created": "2024-03-04T10:30:00Z",
      "amount": {
        "amount": "100.00",
        "currency": "AUD"
      },
      "status": "APPROVED",
      "merchantReference": "merchant-event-ref-789",
      "orderId": 123
    }
  ],
  "requestId": "req_abc123def456",
  "consumerReference": "cust_12345",
  "email": "j***@e***.com"
}

Creates a new billing agreement from an order token.

Deprecated. For new integrations, see Grants.

Creates a new billing agreement from an order token. *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

The token returned from the create approval request.

requestIdstringOptional<=64 characters

A unique request ID, required for idempotent retries. It is recommended that the merchant generate a UUID for each unique request.

merchantReferencestringOptional

The reference order id that this payment corresponds to in the merchant’s system. Note: Providing a new value will update any value previously set in the Create Checkout request.

Response

Billing agreement created successfully

tokenstring

Unique token identifying the agreement

type"BILLING"

Type of agreement

statusenum

Current status of the agreement

createddatetime

Timestamp when the agreement was created

merchantReferencestringOptional

Merchant's reference for this agreement

cancelleddatetimeOptional

If present, indicates when the agreement was cancelled

expiresdatetimeOptional

If present, indicates when the agreement's status will become EXPIRED, preventing a client from using it to create payments

eventslist of objectsOptional

List of events associated with this agreement

requestIdstringOptional

Unique identifier for the request

consumerReferencestringOptional

Reference identifier for the consumer

emailstringOptional

Masked email address of the consumer

Errors

403

Create Billing Agreement Request Forbidden Error

412

Create Billing Agreement Request Precondition Failed Error

415

Create Billing Agreement Request Unsupported Media Type Error

Authentication

Headers

Request

Response

Errors