put
https://www.pelcro.com/api/v1/core/subscriptions/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Update an existing subscription. You can modify various attributes like metadata, shipping address, or auto-renewal settings. When plan_id is provided, the subscription is changed to the new plan with proration.
Example: Update a subscription's shipping address when a customer moves to a new location. Or change from a Monthly to an Annual plan with prorated billing.
Conditional Requirements
| Condition | Required Fields |
|---|---|
collection_method=charge_automatically | source_id |
plan_id is set (plan change) | proration_behavior, payment_behavior, billing_cycle_anchor auto-default if not provided |
end_date is set | Must be a Unix timestamp >= current period end |
auto_renew is set | Cannot also set plan_id in the same request |
plan_id + address_id when taxes enabled | Not allowed — update address and plan separately |
| Subscription is scheduled | Cannot be updated |
| Subscription has pending payment | Cannot be updated |
Webhooks
All updates trigger the subscription.updated webhook event.
Plan changes additionally trigger the subscription.changed webhook event.