plans

Update plan

Updates a plan with the CREATED or ACTIVE status. For an INACTIVE plan, you can make only status updates.<br/>You can patch these attributes and objects:<table><thead><tr><th>Attribute or object</th><th>Operations</th></tr></thead><tbody><tr><td><code>description</code></td><td>replace</td></tr><tr><td><code>payment_preferences.auto_bill_outstanding</code></td><td>replace</td></tr><tr><td><code>taxes.percentage</code></td><td>replace</td></tr><tr><td><code>payment_preferences.payment_failure_threshold</code></td><td>replace</td></tr><tr><td><code>payment_preferences.setup_fee</code></td><td>replace</td></tr><tr><td><code>payment_preferences.setup_fee_failure_action</code></td><td>replace</td></tr><tr><td><code>name</code></td><td>replace</td></tr></tbody></table>

patch/v1/billing/plans/{id}

Request

Path parameters

idstring required

The ID of the subscription.

Headers

Content-Typestring required

The media type. Required for operations with a request body. The value is application/<format>, where the format is json.

Request body

pathstring

The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location at which to complete the operation.

valueunknown
fromstring

The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location from which to move the value. Required for the <code>move</code> operation.

Response

A successful request returns the HTTP 204 No Content status code with no JSON response body.

Changes

No recorded changes to this operation across all 1 revision of this API.