Record retention offers shown in the cancel flow
Customer billing-session cancellation evidence. Offers are recorded only when each is available to this customer now; keys and people are refused.
/subscriptions/{subscription}/cancel_flow/offers_shownCustomer billing-session cancellation evidence. Offers are recorded only when each is available to this customer now; keys and people are refused.
Authorization
bearerAuth In: header
Path Parameters
Opaque subscription ID.
^sbs_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/subscriptions/string/cancel_flow/offers_shown" \ -H "Content-Type: application/json" \ -d '{ "offers": [ { "offer": "skip_period" } ] }'{ "subscription_id": "string", "step": "flow_opened", "cancel_offered_at": "2019-08-24T14:15:22Z", "offers": [ { "offer": "skip_period", "periods": 1 } ]}Set Purchase Requirements PUT
Preview and confirm purchase requirement changes. Members and platform staff may preview but cannot confirm. Confirmation requires a bearer key or agent; live confirmation also requires catalog:publish.
Skip whole billing periods POST
Customers accept this from an opened cancel flow when the product offers it; merchants give a reason. Monthly, flexible-billing subscriptions only. No access while paused; the subscription restarts on the restart date with a normal payment. Pauses run to the selected restart date; early resume is unavailable. Customer pause requires both product access_policy.pause_enabled and company customer_self_service.pause (default false). After enabling company pause, customers must sign in again to receive the pause flow; existing sessions do not gain it.