Saltar al contenido principal

Update Subscription

PUT 
/subscriptions/:id

Updates the configuration of an existing subscription.

Modifiable Parameters:

  • Billing information (priceId, 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

Switching price:

  • A new priceId replaces amount, interval and intervalCount with the price's values. The price must be active and in the subscription's currency
  • On a PENDING subscription the switch also replaces the trial with the price's trial
  • The switch follows the same rules as a manual change: it applies from the next period, or settles at once with prorate
  • Without priceId, changing amount, interval or intervalCount removes priceId and productId

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

Request​

Responses​

A subscription object

Última actualización en