put
https://www.pelcro.com/api/v1/core/plans/
Update an existing plan.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Update an existing plan. All fields are optional — only provided fields are changed.
Image upload
The image field accepts a file upload (not a URL). Use multipart/form-data content type when uploading an image.
Renewal trigger
renewal_trigger decides what closes a billing cycle.
| Value | Cycle ends |
|---|---|
date (default) | On the subscription's renewal date, as it always has. |
shipments_exhausted | As soon as every shipment the cycle paid for has been delivered, whatever the calendar says. |
shipments_exhausted requires recognized_revenue_type to be shipments and a shipments_per_interval to be set; the request is rejected otherwise.
Subscriptions on a shipments_exhausted plan behave differently in three ways:
- Their
renews_atandexpires_atmove to the moment the last issue was delivered once the cycle's invoice runs out of shipments. Those dates are derived, so they cannot be set directly. - They cannot be renewed ahead of time. Renew subscription returns
422for them, because renewing early would extend the cycle by a date the plan does not bill on. Adjust the subscription's remaining shipments instead. - They never generate an advance invoice, since there is no future period to invoice for.
Revenue is recognized against the invoice that paid for each shipment rather than against the calendar period, so a fulfilment approved after the cycle closed is still recognized.