Subscriptions

Preview subscription modification

Changed on

Preview the impact of a mid-cycle subscription modification (inheritance, quantity change, grouped invoicing, trial end, coupon, or tax) without committing changes.

post/subscriptions/{id}/modify/preview

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/subscriptions/{id}/modify/preview
  • 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' required

Response

OK

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 VOIDED enum value to the //// response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new coupon enum value to the request property

    • info

      added the new tax enum value to the request property

    • info

      added the new trial_end 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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • warning

      removed the optional property from the response with the status

    • 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

    • warning

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

    • info

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