Skip to main content

Interface: UpdateSubscriptionParams

Extends​

Properties​

commit?​

optional commit: boolean

Controls whether the QUEUED charges linked to the subscription should be regenerated upon subscription update. By default the flag is set to false which will delay charge regeneration 5 seconds. This enables running multiple calls to perform changes and receive responses much faster since the API won’t wait for a charge regeneration to complete. Setting this parameter to true will cause charge regeneration to complete before returning a response.

Inherited from​

BasicSubscriptionParams.commit

force_update?​

optional force_update: boolean

If set to True, updates will also be applied to CANCELLED subscriptions. If null or False, only ACTIVE subscriptions will be updated.

Inherited from​

BasicSubscriptionParams.force_update