post
https://production-api.shoutaboutus.com/api/v1/billing/checkout-details
Returns a partner-level checkout preview for a plan: the plan pricing plus the count and list of the partner's active/pending stores (where the store's who_will_pay is partner) that the plan would apply to. cancel_plan filters the store set by whether the store's latest plan is already flagged for cancellation. Read-only preview — nothing is charged or written.
Auth
- Bearer partner token.
partner_idmust be abundle_id = 1partner company inside the caller's hierarchy (exists+ an ownership check). Eachaccount_ids[]must be abundle_id = 3account company in the caller's hierarchy.
Rate limit
- No rate limit.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
plan_id | integer | Required | Must be an existing plan. |
partner_id | integer | Required | bundle_id = 1 partner company in caller's hierarchy. Matched as partner.id OR partner.company_id. |
all_account | integer (0|1) | Required | 1 = all accounts under the partner; 0 = only account_ids. |
account_ids | integer[] | Required if all_account = 0 | Each a bundle_id = 3 account company in caller's hierarchy. |
cancel_plan | integer (0|1) | Optional | 0/empty = only stores NOT flagged for cancellation; 1 = only stores whose latest plan has a cancel_subscription_at. |
Behaviour
200— double-wrapped envelope{ data: { data: {.} } }(controller passes['data' =>.]into the{ data. }responder). Payload:plan_id,plan_name,plan_short_info,price,original_price,total_location(matched store count),plan_start(today),plan_end(end of month),store_ids(matched store ids).422— validation failure (missing/invalid plan, partner out of scope,account_idsrequired whenall_account = 0).
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…