View as Markdown
API Spec (JSON)
API Spec (YAML)
Compact modeHides field descriptions and other prose for a more compact, scannable view of the API reference.Note: For the PayPal payment method, you cannot update the `start_date` after the agreement is created.
Client CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheaderScopes
https://uri.paypal.com/services/subscriptionsapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
bodyarray<patch_request>Optionalapplication/json
curl -X PATCH "https://example.com/billing-agreements/string" \ -H "Content-Type: application/json" \ -d '[ { "op": "replace", "path": "/", "value": { "description": "Updated description.", "start_date": "2017-12-22T09:13:49Z", "shipping_address": { "line1": "Hotel Blue Diamond", "line2": "Church Street", "city": "San Jose", "state": "CA", "postal_code": "95112", "country_code": "US" } } } ]'