v2

latestOpenAPI 3.0.3Proprietary2026-07-263483431.1 MB

Customer Subscriptions

Upgrade a subscription item

Customer-authenticated storefront endpoint. Upgrades a subscription item to a higher-priced variant. Creates a subscription action with type 'upgrade' and executes it within the same transaction. The variant_id must be present in the list of upgrade variants.

post/v3/stores/{store_id}/customers/me/subscription-items/{id}/upgrade

Request body

variant_idinteger required

ID of the variant to upgrade to

Response

Subscription item upgraded successfully

activated_atstring date-time

The date and time when the subscription was activated.

business_customer_idstring uuid

Identifier for the business customer associated with the subscription.

business_idstring uuid

Identifier for the business associated with the subscription.

canceled_atstring date-time

The date and time when the subscription was canceled.

current_period_endstring date-time

The end date of the current billing period.

current_period_startstring date-time

The start date of the current billing period.

customer_idstring uuid

Identifier for the customer associated with the subscription.

expired_atstring date-time

The date and time when the subscription expired.

idstring uuid

Unique identifier for the subscription.

inserted_atstring date-time

The date and time when the subscription was created.

interval'day' | 'week' | 'month' | 'year'

Unit of the period

interval_countinteger

The number of intervals between each billing cycle.

is_activeboolean

Indicates if the subscription is currently active.

is_cancel_at_period_endboolean

Indicates if the subscription will cancel at the end of the current period.

order_idstring uuid nullable

The order ID associated with the subscription creation. Null for free trial subscriptions.

status'unactivated' | 'active' | 'canceled' | 'expired' | 'failed'

The status of the subscription.

store_idstring uuid

Identifier for the store associated with the subscription.

subscription_idstring nullable

Human-readable subscription identifier (e.g. YYMMDD + random alpha).

updated_atstring date-time

The date and time when the subscription was last updated.