Subscriptions

Execute subscription modification

Changed on

Execute a mid-cycle subscription modification (inheritance, line item change, grouped invoicing, trial end, coupon, tax, a single addon add/remove, or a batch of addon adds and removes settled as one netted document). Type "quantity_change" is deprecated: use "line_item_change", which changes a fixed charge's quantity, price, or both, with the same proration and checkout behaviour.

post/subscriptions/{id}/modify/execute

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/subscriptions/{id}/modify/execute
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Subscription ID

Request body

type'inheritance' | 'quantity_change' | 'grouped_invoicing' | 'trial_end' | 'coupon' | 'tax' | 'addon' | 'line_item_change' required

Response

OK

Changes

  • 84cb4a3af400Revision changes
    • info

      added the optional property //// to the response with the status

  • c68a971ce7b5Revision changes
    • info

      added the new optional request property /

    • info

      added the new modify enum value to the request property /

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status