Preview partner charges

Preview what moving locations onto a plan would cost for the rest of this month, before you check out. Send the plan (plan_id), the partner (partner_id) and either all_account: 1 or a list of account_ids. You get the plan's price and how many of the partner's partner-paid, active or pending locations it would apply to (with their ids), for today through the end of the month. With cancel_plan: 1 it counts the locations that already have a cancellation scheduled instead. It's a single total for one plan; it isn't broken down by account or location.

Prerequisites: a Partner token, the plan's id (plan_id), and the ids of the accounts to include unless you send all_account: 1.

Authentication: Partner token. partner_id must be a partner inside your own tree (your partner, or a sub-partner under it), and every id in account_ids an account inside your tree; otherwise 422.

Rate limit: 120 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 3

The plan to price. Must exist.

integer
required
Defaults to 123

The partner whose locations to count. Must be a partner inside your tree. Locations in accounts under its sub-partners are counted too.

integer
enum
required
Defaults to 0

1: every account under the partner. 0: only the accounts in account_ids.

Allowed:
account_ids
array of integers
Defaults to 5994

The accounts to include. Each must be an account inside your tree. Required when all_account is 0.

account_ids
integer | null
enum
Defaults to 0

1: count only locations that already have a cancellation scheduled. 0 or left out: count only locations without one.

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json