Subscriptions

Remove addon from subscription

Changed on

Deprecated: use POST /subscriptions/{id}/modify/execute with type "addon" and action "remove", which also supports previewing the proration credit first. Use when removing an add-on from a subscription (e.g. downgrade or opt-out).

delete/subscriptions/addon

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/subscriptions/addon
  • Auth
    API key in header x-api-key

Request body

addon_association_idstring required
change_at'immediate' | 'end_of_period'
effective_datestring date-time

EffectiveDate defaults to period end when nil; mid-period with create_prorations issues a wallet credit.

proration_behavior'create_prorations' | 'none'
reasonstring

Response

OK

messagestring

Changes