Subscriptions

Pause subscription

Changed on

Use when a customer stops temporarily. Pauses an active subscription now: usage and arrear fixed charges up to the pause are billed on a closing invoice, and every paused period after it gets a $0 skipped invoice.

post/subscriptions/{id}/pause

Request

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

Path parameters

idstring required

Subscription ID

Request body

metadataobject

Metadata stored on the pause @Example {"requested_by": "customer", "channel": "support_ticket"}

proration_behavior'create_prorations' | 'none'
reasonstring

Reason for pausing the subscription @Description Optional reason for the pause. Maximum 255 characters @Example "Customer requested temporary suspension"

Response

OK

Changes