PATCH /v1/stores/{id}, or from the
store’s page in the partner dashboard; both
do the same thing, and each store has its own switches.
The add-ons
There are three you can switch on. A price is per store, before IVA, and IVA is added to every charge.add_ons also lists wallet (Restaurant balance) and full_console (Full
console) with available: false. They cannot be switched on: a request that
asks for either is refused and nothing is charged.
Two kinds of charge, then:
- Monthly (
ratings): charged when you switch the add-on on, and again on the same day of each month. - Per use (
customer_whatsapp,card_payments): nothing up front. Each delivered trip or each paid card payment is charged when it happens.
Reading add-ons on a store
Every store object carriesadd_ons: the create response,
GET /v1/stores/{id}, every row of GET /v1/stores, the update response and
the store a store.updated event carries. It is null on a store add-ons do
not apply to. Otherwise it has one entry for each of the five keys, always
present:
The schema’s
status also lists scheduled and past_due. They appear only for wallet and full_console, which cannot be switched on today, so the three add-ons you can switch on show only off, on and ending.
Switching add-ons on and off
Send the add-ons you want to change underadd_ons, each as true or false.
A key you leave out stays as it is.
200 with the whole store, add_ons included, in the state it
ended in. Every key is checked before anything changes, so a request with one
wrong key changes nothing.
A few rules:
walletandfull_consolecannot be switched on. A request that sets either totrueis refused with422 validation_failedandparam: "add_ons.wallet"or"add_ons.full_console", before anything changes or is charged. Setting either tofalseis accepted.- Per-use add-ons switch on and off in the same request as much as you like.
When the first month cannot be paid
Switching a monthly add-on on charges its first month in the same request, from your balance, or from your card if you chose card for plan charges on the dashboard’s Planes y facturación page. If it cannot be paid, the request is refused and nothing changes: the add-on stays off and nothing is charged.Idempotency-Key so a request that timed out can be repeated without charging
twice.
Renewals and switching off
A monthly add-on is charged again onrenews_on, the same day of each month,
from the same balance or card.
- A renewal that cannot be paid switches the add-on off at the end of the month you already paid. You get an email, and nothing is owed. You can switch it on again whenever you like, which charges a new month.
- Switching a monthly add-on off keeps it running until the end of the month
you paid:
statusreadsendingandends_onnames the last day. Nothing is refunded and nothing more is charged. Switch it back on beforeends_onand it simply continues, with no new charge.
Per-use charges
customer_whatsapp and card_payments are charged to your balance each time
they are used: customer_whatsapp when a trip is delivered, and card_payments
when a customer’s card payment is paid. They are never charged to your card. A
refund of a card payment does not return its MX$5.
In test mode
Test stores can switch oncustomer_whatsapp, ratings and card_payments,
the same three as live stores. Per-use charges go to your test balance, and
nothing real is charged. See test mode.
On your ledger
What add-ons charge to your balance appears onGET /v1/ledger:
See balance and withdrawals.
The store.updated event
Every change to a store’s add-ons sends a store.updated event carrying the
whole store object, add_ons included: an add-on switched on, switched off or
ended. Read the add_ons each event carries rather than
counting events. See webhooks.