FAfatzebra

Cancel a billing agreement

Changed on
post/paypal/billing_agreements/{id}/cancel

Request

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

Path parameters

idstring required

The ID of the billing agreement.

Headers

Content-Typestring

Response

200

successfulboolean

Example response

{
  "successful": true,
  "response": {
    "id": "071-PBA-ETCGSDAKH8TPIL99",
    "name": "Sample Billing Agreement",
    "description": "Stored PayPal account",
    "state": "Inactive",
    "payer": {
      "payer_info": {
        "email": "test-buyer@example.com",
        "first_name": "Test Buyer",
        "last_name": "Buyer",
        "payer_id": "SFGQGH2A8UA4W"
      }
    },
    "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"
  }
}

Changes