Synq Docs
Management APIOrgs

Change an org

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

PATCH/v1/orgs/{org}

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

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

curl -X PATCH "https://example.com/v1/orgs/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "slug": "string",  "name": "string",  "default_brand_id": "string",  "plan": "string",  "created_at": "2019-08-24T14:15:22Z",  "disabled_at": "2019-08-24T14:15:22Z",  "disabled_reason": "string"}

List the orgs the caller can act in GET

An API key's own org; a person's orgs, those they are a member of. Needs no permission.

Start checkout for a plan POST

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`.