Update Subscription

put

https://{subdomain}.recurly.com/v2/subscriptions/{uuid}

TIMEFRAME

The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now or when the subscription renews. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to "renewal" so the change takes affect at the end of the current billing cycle.

ADD-ONS

The original subscription's add-ons will be removed unless they are specified in your update subscription request. Please specify all the add-ons that should be present after the subscription change.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

string

required

Uuid.

Body Params

timeframe

string

Defaults to "now"

"now" for immediate, "renewal" to perform when the subscription renews. defaults to "now" if not specified

plan_code

string

New plan, remains unchanged if not specified

quantity

integer

New quantity, remains unchanged if not specified and the plan_code remains the same

unit_amount_in_cents

integer

New unit amount in cents

collection_method

string

Optional field to set the collection for an invoice as "automatic" or "manual". The default is "automatic" if it's not set.

net_terms

integer

Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly. Defaults to '0'.

po_number

string

Optional notes field. Attach a PO number to the invoice.

subscription_add_ons

array

Nested add-on information for the subscription, the new subscription will have no add-ons unless specified

subscription_add_ons

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

400