Retrieve Billing Agreement Offers | Welcome to Afterpay Documentation

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

{
  "consumerMaskedEmail": "j***@e***.com",
  "consumerAmount": {
    "amount": "200.00",
    "currency": "USD"
  },
  "offers": [
    {
      "type": "PAY_IN_4",
      "merchantAmount": {
        "amount": "200.00",
        "currency": "USD"
      },
      "exchangeRate": 1.35,
      "amountDueToday": {
        "amount": "50.00",
        "currency": "USD"
      },
      "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": "20.00",
        "currency": "USD"
      },
      "consumer": {
        "noPaymentUpFront": {
          "eligible": true,
          "eligibilityLimit": {
            "amount": "2000.00",
            "currency": "USD"
          }
        }
      }
    }
  ]
}

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

The request containing the amount and billing agreement token to check offers for

requestIdstringRequired

A unique identifier for this request

amountobjectRequired

The amount to check offers for

tokenstringRequired

The billing agreement token

Response

Offers retrieved successfully

consumerMaskedEmailstring

Masked email address of the consumer

consumerAmountobject

Amount in consumer's currency

offerslist of objects

List of available offers details

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

Authentication

Headers

Request

Response

Errors