Sign in
customer_portal
subscriptions
public

Update Subscription

Update a subscription of the authenticated customer.

patch/v1/customer-portal/subscriptions/{id}

Path parameters

idstring uuid4 required

The subscription ID.

The subscription ID.

Request body

OR
OR
OR
OR
OR

Response

Customer subscription updated.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

amountinteger required

The amount of the subscription.

currencystring required

The currency of the subscription.

recurring_interval'day' | 'week' | 'month' | 'year' required
recurring_interval_countinteger required

Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on.

status'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused' required
current_period_startstring date-time required

The start timestamp of the current billing period.

current_period_endstring date-time required

The end timestamp of the current billing period.

current_meter_period_startstring date-time nullable required

The start timestamp of the current meter period, if the product has a meter cycle set. Metered credits are granted and overage is settled on this cadence.

current_meter_period_endstring date-time nullable required

The end timestamp of the current meter period, if the product has a meter cycle set. This is when credits next renew.

trial_startstring date-time nullable required

The start timestamp of the trial period, if any.

trial_endstring date-time nullable required

The end timestamp of the trial period, if any.

cancel_at_period_endboolean required

Whether the subscription will be canceled at the end of the current period.

canceled_atstring date-time nullable required

The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.

started_atstring date-time nullable required

The timestamp when the subscription started.

ends_atstring date-time nullable required

The timestamp when the subscription will end.

ended_atstring date-time nullable required

The timestamp when the subscription ended.

past_due_atstring date-time nullable

The timestamp when the subscription entered past_due status.

pause_at_period_endboolean required

Whether the subscription will be paused at the end of the current period.

paused_atstring date-time nullable required

The timestamp when the subscription was paused.

resumes_atstring date-time nullable required

The timestamp when a paused subscription is scheduled to automatically resume, if set.

customer_idstring uuid4 required

The ID of the subscribed customer.

product_idstring uuid4 required

The ID of the subscribed product.

discount_idstring uuid4 nullable required

The ID of the applied discount, if any.

checkout_idstring uuid4 nullable required
seatsinteger nullable

The number of seats for seat-based subscriptions. None for non-seat subscriptions.

customer_cancellation_reason'customer_service' | 'low_quality' | 'missing_features' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused' | 'other' required
customer_cancellation_commentstring nullable required

Example response

{
  "amount": 10000,
  "currency": "usd",
  "meters": [
    {
      "consumed_units": 25,
      "credited_units": 100,
      "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22"
    }
  ]
}

Changes