FLflexprice
Subscriptions

Remove addon from subscription

Changed on

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
effective_datestring date-time

EffectiveDate is the date the cancellation takes effect. When nil the addon is cancelled at the end of the current period. When provided it must fall within [CurrentPeriodStart, CurrentPeriodEnd]; mid-period values combined with create_prorations will issue a wallet credit for unused time.

proration_behavior'create_prorations' | 'none'
reasonstring

Response

OK

messagestring

Changes

  • f62d8a5fe7cfRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new too_many_requests enum value to the response property for the response status

    • warning

      added the new too_many_requests enum value to the response property for the response status

  • 0cb3425d6580Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property