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.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.
amountobject<money>Requiredcurrency_codestring<currency_code>RequiredvaluestringRequiredapplication/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/billing/subscriptions/string/capture" \ -H "Content-Type: string" \ -H "Content-Type: application/json" \ -d '{ "note": "string", "capture_type": "OUTSTANDING_BALANCE", "amount": { "currency_code": "str", "value": "string" } }'{ "status": "COMPLETED", "id": "string", "amount_with_breakdown": { "gross_amount": { "currency_code": "str", "value": "string" }, "total_item_amount": { "currency_code": "str", "value": "string" }, "fee_amount": { "currency_code": "str", "value": "string" }, "shipping_amount": { "currency_code": "str", "value": "string" }, "tax_amount": { "currency_code": "str", "value": "string" }, "net_amount": { "currency_code": "str", "value": "string" } }, "payer_name": { "prefix": "string", "given_name": "string", "surname": "string", "middle_name": "string", "suffix": "string", "full_name": "string" }, "payer_email": "string", "time": "stringstringstringst"}