Synq Docs
Management APIOrgs

Start checkout for a plan

Stripe Checkout for one of the plans sold (`GET /v1/plans`), billed monthly or yearly, with the plan's overage for monthly active users above the allowance as a metered item; promotion codes are taken. Send the person to `url`; once they've paid, Stripe's webhook moves the org to the plan, moments later. An org that pays for a plan already changes it in the billing portal instead. Needs `org.billing.edit`.

POST/v1/orgs/{org}/billing/checkout

Stripe Checkout for one of the plans sold (GET /v1/plans), billed monthly or yearly, with the plan's overage for monthly active users above the allowance as a metered item; promotion codes are taken. Send the person to url; once they've paid, Stripe's webhook moves the org to the plan, moments later. An org that pays for a plan already changes it in the billing portal instead. Needs org.billing.edit.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/orgs/string/billing/checkout" \  -H "Content-Type: application/json" \  -d '{    "plan": "string",    "success_url": "http://example.com",    "cancel_url": "http://example.com"  }'
{  "id": "string",  "url": "http://example.com"}

Change an org PATCH

Its name or slug. Needs `org.edit`. Recorded as `org.updated`. Its brands' issuer slugs never change.

Change a paying org's plan POST

Moves an org that pays for a plan to another plan or cadence. An upgrade (a dearer plan, or monthly to yearly) applies at once: Stripe prorates it and invoices the difference now, on the card it has. A downgrade (a cheaper plan, or yearly to monthly) applies at the end of the period paid for. The org's plan follows Stripe's webhook, moments after. To stop paying, cancel in the billing portal. Needs `org.billing.edit`.