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
readwriteapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
billing_cycleenum<BillingCycle>Optionalamountobject<Amount>Optionalcurrency_codestring<Currency>Requiredminimum_commitmentobject<MinimumCommitmentRequest>Optionalamountobject<AmountNoCurrency>Requiredusage_based_chargesobject<UsageBasedChargeUpdateRequest>[]Optionalcharge_modelenum<ChargeModel>Optionalmin_amountobject<AmountNoCurrency>Optionalapplication/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/plans/Plan-Code-1758211957" \ -H "Content-Type: application/json" \ -d '{}'{ "status": "200 OK", "headers": { "Content-Type": "application/json" }, "body": { "name": "UBB Plan - Pro", "code": "ubb_plan_1753837176", "billing_cycle": "WEEKLY", "description": "Pro plan for pro UBB customers", "amount": { "value": 170, "currency_code": "USD" }, "trial_period": 0, "pay_in_advance": true, "cascading_updates": true, "usage_based_charges": [ { "id": "fggdgd5c-31a6-4d74-b607-ac3915796ab9", "metric_id": "92c9175c-31a6-4d74-b607-ac3915796ab9", "charge_model": "STANDARD", "properties": { "amount": "1.00" }, "min_amount": { "value": 1, "currency_code": "USD" } } ], "minimum_commitment": { "amount": { "value": 100, "currency_code": "USD" }, "invoice_display_name": "Minimum Commitment", "id": "cc82edfd-8198-4942-bed8-fcd7afb5191e", "plan_code": "ubb_plan_1753826420", "created_at": "2025-07-31T08:41:19Z", "updated_at": "2025-07-31T08:41:19Z" }, "created_at": "2025-07-30T00:59:35Z", "updated_at": "2025-07-31T08:41:19Z", "id": "95de3538-3827-496b-89a0-120745360830" }}