Skip to main content

Interface: UpdateSubscriptionRequest

Extends​

  • Partial<Pick<Subscription, "charge_interval_frequency" | "expire_after_specific_number_of_charges" | "external_variant_id" | "next_charge_scheduled_at" | "order_day_of_month" | "order_day_of_week" | "order_interval_frequency" | "order_interval_unit" | "properties" | "quantity"> & object>

Extended by​

Properties​

charge_interval_frequency?​

optional charge_interval_frequency: number

The number of units (specified in order_interval_unit) between each Charge. For example, order_interval_unit=month and charge_interval_frequency=3, indicate charge every 3 months. Charges must use the same unit types as orders. Max: 1000

Inherited from​

Partial.charge_interval_frequency

expire_after_specific_number_of_charges?​

optional expire_after_specific_number_of_charges: number

Set the number of charges until subscription expires.

Inherited from​

Partial.expire_after_specific_number_of_charges

external_variant_id?​

optional external_variant_id: ExternalId

An object containing the variant id as it appears in external platforms.

Inherited from​

Partial.external_variant_id

next_charge_scheduled_at?​

optional next_charge_scheduled_at: string

Date of the next charge for the subscription.

Inherited from​

Partial.next_charge_scheduled_at

order_day_of_month?​

optional order_day_of_month: number

The set day of the month order is created. Default is that there isn’t a strict day of the month when the order is created. This is only applicable to subscriptions with order_interval_unit:“month”.

Inherited from​

Partial.order_day_of_month

order_day_of_week?​

optional order_day_of_week: number

The set day of the week order is created. Default is that there isn’t a strict day of the week order is created. This is only applicable to subscriptions with order_interval_unit = “week”. Value of 0 equals to Monday, 1 to Tuesday etc.

Inherited from​

Partial.order_day_of_week

order_interval_frequency?​

optional order_interval_frequency: number

The number of units (specified in order_interval_unit) between each order. For example, order_interval_unit=month and order_interval_frequency=3, indicate order every 3 months. Max value: 1000

Inherited from​

Partial.order_interval_frequency

order_interval_unit?​

optional order_interval_unit: IntervalUnit

The frequency unit used to determine when a subscription’s order is created.

Inherited from​

Partial.order_interval_unit

plan_id?​

optional plan_id: number

subscription plan_id - if included on update request then charge_interval_frequency/order_interval_frequency/order_interval_unit are not required

Inherited from​

Partial.plan_id

properties?​

optional properties: Property[]

A list of line item objects, each one containing information about the subscription. Custom key-value pairs can be installed here, they will appear on the connected queued charge and after it is processed on the order itself.

Inherited from​

Partial.properties

quantity?​

optional quantity: number

The number of items in the subscription.

Inherited from​

Partial.quantity