Endpoints 22
- Reads the store's business.GET
/v1/stores/{store}/organization - Updates the business's name and details.PATCH
/v1/stores/{store}/organization - Sets or clears the business's logo from a file.PUT
/v1/stores/{store}/organization/logo - Reads the business's payout balance.GET
/v1/stores/{store}/balance - Lists the business's payouts.GET
/v1/stores/{store}/payouts - Previews what one more store on the business's plan charges now and bills from its next renewal.POST
/v1/stores/{store}/plan_store/preview/query - Turns on or off upgrading automatically when the business goes over a limit: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, with Pro's price prorated to the card on file. Off by default; never for a cancelled plan, a free trial or a failed payment.PUT
/v1/stores/{store}/organization/auto_upgrade - Turns on or off adding Pro's add-on blocks on their own: when a store's storage or AI video minutes would pass what the plan and the blocks held cover, a block of 100 GB or 600 minutes a month is added, $10 a month, charged at once prorated on the card on file. Only ever adds; never during a free trial. Off, uploads and transcriptions stop at what's covered. On by default for new businesses.PUT
/v1/stores/{store}/organization/auto_add_ons - Pages the store's customer notifications.GET
/v1/stores/{store}/notifications - Creates a customer notification for an event.POST
/v1/stores/{store}/notifications - Deletes a notification; the store's defaults are turned off instead.DEL
/v1/stores/{store}/notifications/{notification} - Updates whether a notification is enabled.PATCH
/v1/stores/{store}/notifications/{notification} - Pages the store's webhook endpoints.GET
/v1/stores/{store}/webhooks - Creates a webhook endpoint and answers its signing secret, which no read answers again. Its events need the read scopes their payloads carry.POST
/v1/stores/{store}/webhooks - Reads one webhook endpoint, never its secret.GET
/v1/stores/{store}/webhooks/{webhook} - Deletes a webhook endpoint and its delivery history.DEL
/v1/stores/{store}/webhooks/{webhook} - Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events' payloads carry.PATCH
/v1/stores/{store}/webhooks/{webhook} - Replaces a webhook endpoint's signing secret and answers the new one once; the old one signs nothing more. Needs the read scopes of its events and of every event it still owes.POST
/v1/stores/{store}/webhooks/{webhook}/secret/roll - Pages a webhook endpoint's recent deliveries: status, attempts and last response code.GET
/v1/stores/{store}/webhook_deliveries - Sends a delivery's event to its endpoint again, with the same event id; needs the read scopes its payload carries.POST
/v1/stores/{store}/webhook_deliveries/{delivery}/resend - Lists the businesses the token may act for, with their stores.GET
/v1/merchants - Reads one business with its stores.GET
/v1/merchants/{merchant}