Retrieve Billing Agreement Offers | Welcome to cash-app Documentation

curl -X POST https://global-api-sandbox.afterpay.com/v2/billing-agreements/offers \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": {
    "amount": "100.00",
    "currency": "AUD"
  },
  "token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2"
}'

{
  "consumerMaskedEmail": "j***@e***.com",
  "consumerAmount": {
    "amount": "100.00",
    "currency": "AUD"
  },
  "offers": [
    {
      "type": "PAY_IN_4",
      "merchantAmount": {
        "amount": "100.00",
        "currency": "AUD"
      },
      "exchangeRate": 1.35,
      "amountDueToday": {
        "amount": "100.00",
        "currency": "AUD"
      },
      "payments": [
        {
          "amount": {
            "amount": "50.00",
            "currency": "USD"
          },
          "dueDate": "2024-03-04"
        },
        {
          "amount": {
            "amount": "50.00",
            "currency": "USD"
          },
          "dueDate": "2024-03-18"
        },
        {
          "amount": {
            "amount": "50.00",
            "currency": "USD"
          },
          "dueDate": "2024-04-01"
        },
        {
          "amount": {
            "amount": "50.00",
            "currency": "USD"
          },
          "dueDate": "2024-04-15"
        }
      ],
      "crossBorder": false,
      "appliedPromotion": {
        "amount": "100.00",
        "currency": "AUD"
      },
      "consumer": {
        "noPaymentUpfront": {
          "eligible": true,
          "eligibilityLimit": {
            "amount": "100.00",
            "currency": "AUD"
          }
        }
      }
    }
  ]
}

Retrieves available offers for billing agreements based on amount and frequency.

Deprecated. For new integrations, see Grants.

Retrieves available offers for billing agreements based on amount and frequency. *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.

requestIdstringRequired

A unique identifier for this request

amountobjectRequired

The amount to check offers for

tokenstringRequired

The billing agreement token

Response

Offers retrieved successfully

consumerMaskedEmailstringOptional

Masked email address of the consumer

consumerAmountobjectOptional

Amount in consumer's currency

offerslist of objectsOptional

List of available offers details

Errors

401

Retrieve Billing Agreement Offers Request Unauthorized Error

403

Retrieve Billing Agreement Offers Request Forbidden Error

422

Retrieve Billing Agreement Offers Request Unprocessable Entity Error

Authentication

Headers

Request

Response

Errors