Read the My ways plan
get_planReturns the plan of the organisation of the token: FREE, PAID, PAST_DUE, ENDING or ENDED; watched solutions billed in the current Stripe period, the coming invoice, the payment provider and the invoices. 1 watched solution free, then €0.50 per watched solution per month, €2 monthly minimum (excl. VAT), invoiced by VORAN, paid through Stripe. A paid watch is billed for a period when it is active at least one day of it, whatever the number of agents that read it. Contract 0.4.0. Needs an organisation token (Authorization: Bearer hodds_...); without it the tool returns the error token_required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | Yes | FREE: one active watch. PAID: watches beyond the free one. PAST_DUE: the last payment failed, watches kept. ENDING: stops at the end of the Stripe period (ends_on). ENDED: stopped; the paid watches were CLOSED. | |
| unit | Yes | ||
| since | Yes | First day of the paid plan; null outside PAID, PAST_DUE and ENDING. | |
| billing | Yes | Name and country of the Stripe customer, as entered at Stripe. | |
| ends_on | Yes | Last day of the plan when it is ENDING, or PAST_DUE with its stop asked; null otherwise. | |
| payment | Yes | The payment method lives at Stripe; no digit of it is stored or returned. | |
| pending | No | Delivery on the next call: alerts that wait for this organisation. Absent when there is nothing to deliver. Only ack_alerts empties it. | |
| summary | Yes | One sentence in English, or in French when the request was in French (or in the language of the organisation). | |
| watches | Yes | ||
| currency | Yes | ||
| invoices | Yes | ||
| invoiced_by | Yes | ||
| next_invoice | Yes | End of the current Stripe period and amount_due_estimate; null outside a paid plan. | |
| watches_total | Yes | Watches listed in watches[]: the active ones and those closed in the last 30 days. | |
| minimum_covers | Yes | Watched solutions covered by the monthly minimum; from the 5th on, €0.50 each. | |
| watches_billed | Yes | Paid watches billed in the current Stripe period (active at least one day of it). | |
| monthly_minimum | Yes | S-79: amount excl. VAT due for each Stripe period while the plan is active. | |
| amount_due_estimate | Yes | max(monthly_minimum, watches_billed × 0.50) for the current period; null outside a paid plan. | |
| price_per_watch_month | Yes |