FAfatzebra

List billing agreements

Changed on
get/paypal/billing_agreements

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/paypal/billing_agreements
  • Auth
    HTTP basic

Query parameters

offsetinteger

Offset to start

limitinteger

Number of records in the response

fromstring date

Lower bound for the time at which the record was created

tostring date

Upper bound for the time at which the record was created

Headers

Content-Typestring

Response

200

successfulboolean
recordsinteger
total_recordsinteger
pageinteger
total_pagesinteger

Example response

{
  "successful": true,
  "response": [
    {
      "id": "071-PBA-ETCGSDAKH8TPIL99",
      "name": "Sample Billing Agreement",
      "description": "Stored PayPal account",
      "state": "Active",
      "payer": {
        "payer_info": {
          "email": "test-buyer@fatzebra.com.au",
          "first_name": "FZ Test Buyer",
          "last_name": "Buyer",
          "payer_id": "SNGQ72BA8UA4W"
        }
      },
      "shipping_address": {
        "first_name": "John",
        "last_name": "Doe",
        "address_1": "100 Kent Street",
        "address_2": "Cafe Lane",
        "city": "Sydney",
        "state": "NSW",
        "postcode": "2000",
        "country": "AU"
      },
      "merchant_custom_data": "UUID",
      "created_at": "2020-08-28T15:37:35+10:00"
    }
  ],
  "records": 2,
  "total_records": 10,
  "page": 1,
  "total_pages": 1
}

Changes