Platform
Platform data, Arky plans, platform administrators, and the platform inboxes
Reference Data
/v1/platform/currencies sdk.platform.findCurrencies() /v1/platform/events sdk.platform.findWebhookEvents() /v1/platform/countries sdk.store.country.find() /v1/stores/plans sdk.platform.findStorePlans() const { items: currencies } = await sdk.platform.findCurrencies();
const { items: events } = await sdk.platform.findWebhookEvents();
const { items: plans } = await sdk.platform.findStorePlans();
- Currencies are every currency Stripe can charge, as lowercase codes.
- Webhook events list each event a webhook can pick, with the filters it takes.
- Store plans are Arky’s own plans, with their tier, interval, price and the limits of each plan.
Platform Administrators
/v1/platform/administrators sdk.platform.administrator.find() /v1/platform/administrators/me sdk.platform.administrator.getMe() /v1/platform/administrators sdk.platform.administrator.add() /v1/platform/administrators/{id} sdk.platform.administrator.remove() interface PlatformAdministrator {
id: string;
account_id: string;
created_at: EpochMilliseconds;
}
await sdk.platform.administrator.add({ id: crypto.randomUUID(), account_id: accountId });
A platform administrator runs Arky itself: full access to every store without a membership, the owner’s actions in any store except transfer, searching all accounts, putting a store on an Arky plan without Stripe, and handling the billing inbox. Administrators add and remove each other in one write; the last one can’t be removed.
Platform Inboxes
/v1/platform/incoming-webhooks/stripe-billing sdk.platform.stripeBillingEvent.find() /v1/platform/incoming-webhooks/stripe-billing/{id}/resolve sdk.platform.stripeBillingEvent.resolve() /v1/platform/incoming-webhooks/resend sdk.platform.resendEvent.find() /v1/platform/incoming-webhooks/resend/{id}/resolve sdk.platform.resendEvent.resolve() Stripe’s billing webhooks for stores’ Arky plans, and the posts of Arky’s own Resend account (reports
on Arky’s own mail and received support mail), land as incoming webhooks, unique per provider event.
Each is waiting (new, retried, or unmatched until its record appears), processing, then
applied, ignored, or review with a reason. An administrator resolves a review or unmatched
event with apply (try it again) or ignore, carrying its expected_updated_at.
A store’s own provider posts (Stripe and Monri payments, and its own Resend account’s reports) are in the store’s incoming webhooks.