Synq Docs
Management APIOrgs

Open Stripe's billing portal

Stripe's customer portal for the org: its payment method, billing details, invoices, and cancelling (at the end of the period paid for). Changing plan is `POST /v1/orgs/{org}/billing/plan`. Send the person to `url`. Needs `org.billing.edit`.

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

Stripe's customer portal for the org: its payment method, billing details, invoices, and cancelling (at the end of the period paid for). Changing plan is POST /v1/orgs/{org}/billing/plan. Send the person to url. 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

curl -X POST "https://example.com/v1/orgs/string/billing/portal" \  -H "Content-Type: application/json" \  -d '{    "return_url": "http://example.com"  }'
{  "url": "http://example.com"}

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

Leave an org POST

For a person, not an API key; the owner hands the org over first. Recorded as `member.left`.