Subscriptions

Update a subscription

Updates an active subscription's properties including billing period, add-ons, unit quantities, and discounts.

patch/api/v1/subscriptions/{id}

Path parameters

idstring required

The unique identifier of the entity

metadataobject

Additional metadata for the subscription

trialEndDatestring date-time

Subscription trial end date

promotionCodestring

Promotion code

billingPeriod'MONTHLY' | 'ANNUALLY'

awaitPaymentConfirmationboolean

Await payment confirmation

scheduleStrategy'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE'

billingCycleAnchor'UNCHANGED' | 'NOW'

The updated subscription object.