PayPal · Example Payload

Paypal Subscriptionsrevise Example

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Paypal Subscriptionsrevise Example is an example object payload from PayPal, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "subscriptions.revise",
  "method": "POST",
  "path": "/v1/billing/subscriptions/{id}/revise",
  "summary": "Paypal Revise plan or quantity of subscription",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "subscription_revise_request",
      "example": {
        "plan_id": "P-5ML4271244454362WXNWU5NQ",
        "shipping_amount": {
          "currency_code": "USD",
          "value": "10.00"
        },
        "shipping_address": {
          "name": {
            "full_name": "John Doe"
          },
          "address": {
            "address_line_1": "2211 N First Street",
            "address_line_2": "Building 17",
            "admin_area_2": "San Jose",
            "admin_area_1": "CA",
            "postal_code": "95131",
            "country_code": "US"
          }
        },
        "application_context": {
          "brand_name": "walmart",
          "locale": "en-US",
          "shipping_preference": "SET_PROVIDED_ADDRESS",
          "payment_method": {
            "payer_selected": "PAYPAL",
            "payee_preferred": "IMMEDIATE_PAYMENT_REQUIRED"
          },
          "return_url": "https://example.com/returnUrl",
          "cancel_url": "https://example.com/cancelUrl"
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "subscription_revise_response",
      "example": {
        "plan_id": "P-5ML4271244454362WXNWU5NQ",
        "plan_overridden": false,
        "shipping_amount": {
          "currency_code": "USD",
          "value": "10.00"
        },
        "shipping_address": {
          "name": {
            "full_name": "John Doe"
          },
          "address": {
            "address_line_1": "2211 N First Street",
            "address_line_2": "Building 17",
            "admin_area_2": "San Jose",
            "admin_area_1": "CA",
            "postal_code": "95131",
            "country_code": "US"
          }
        },
        "links": [
          {
            "href": "https://www.paypal.com/webapps/billing/subscriptions/update?ba_token=BA-2M539689T3856352J",
            "rel": "approve",
            "method": "GET"
          },
          {
            "href": "https://api-m.paypal.com/v1/billing/subscriptions/I-BW452GLLEP1G",
            "rel": "edit",
            "method": "PATCH"
          },
          {
            "href": "https://api-m.paypal.com/v1/billing/subscriptions/I-BW452GLLEP1G",
            "rel": "self",
            "method": "GET"
          },
          {
            "href": "https://api-m.paypal.com/v1/billing/subscriptions/I-BW452GLLEP1G/cancel",
            "rel": "cancel",
            "method": "POST"
          },
          {
            "href": "https://api-m.paypal.com/v1/billing/subscriptions/I-BW452GLLEP1G/suspend",
            "rel": "suspend",
            "method": "POST"
          },
          {
            "href": "https://api-m.paypal.com/v1/billing/subscriptions/I-BW452GLLEP1G/capture",
            "rel": "capture",
            "method": "POST"
          }
        ]
      }
    }
  ]
}