Update Subscription

PUT 
/subscriptions/:id

Updates the configuration of an existing subscription.

Modifiable Parameters:

• Billing information (amount, interval, intervalCount, description, allowedPaymentMethods)
• Customer details (contact information, billing/shipping addresses)
• Subscription settings (cancelAtPeriodEnd, pauseAtPeriodEnd, skipIntervalCount)
• Metadata (for your internal tracking)

Update Effects:

• Amount changes apply to the next billing cycle
• Interval changes apply from the next period, leaving the current one to run out
• Setting prorate to true settles the price difference immediately instead, and an interval change then restarts the billing period from now
• nextPaymentAt moves the next charge date on its own, leaving the price alone. With prorate it also settles the time that moves: later charges for it, earlier refunds it
• Customer information updates take effect immediately
• Setting cancelAtPeriodEnd to true will end the subscription after the current period
• Setting pauseAtPeriodEnd to true will pause billing after the current period
• Setting skipIntervalCount skips billing for the specified number of intervals without changing subscription status

Note: The currency cannot be changed once a subscription is created. To change it, cancel the subscription and create a new one.

Request

Responses

200

A subscription object

400

The request is incorrect or could not be processed

401

Unauthorized error. Please check your auth credentials

404

The specified resource was not found

422

The request was well-formed but could not be processed due to semantic errors

500

Unexpected server error

503

The service is temporarily unavailable