FLflexprice
Subscriptions

Add addon to subscription

Changed on

Use when adding an optional product or add-on to an existing subscription (e.g. extra storage or support tier).

post/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_idstring required
cadence'onetime' | 'recurring'
line_item_commitmentsobject

LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id)

metadataobject
proration_behavior'create_prorations' | 'none'
start_datestring date-time
subscription_idstring required

Response

OK

addon_idstring
addon_status'active' | 'cancelled' | 'pending'
cancellation_reasonstring
cancelled_atstring date-time
created_atstring date-time
created_bystring
end_datestring date-time
entity_idstring
entity_type'subscription' | 'plan' | 'addon'
environment_idstring
idstring
metadataobject
start_datestring date-time
status'published' | 'deleted' | 'archived'
tenant_idstring
updated_atstring date-time
updated_bystring

Changes

  • cef2964c102cRevision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      added the new config enum value to the //// response property for the response status

    • warning

      added the new config enum value to the /// response property for the response status

    • info

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

  • 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