Skip to main content

Interface: UpdateSubscriptionsParams

Extends

Properties

allow_onetimes?

optional allow_onetimes: boolean

Allows onetimes to be updated with subscriptions

Inherited from

BulkSubscriptionParams.allow_onetimes


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

BulkSubscriptionParams.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.