Error

A valid request URL is required to generate request examples

{
  "providers": [
    {
      "provider": "stripe",
      "connected": true,
      "adapter_available": true,
      "capabilities": {
        "scheduled_plan_change": true,
        "proration": true,
        "cancel_at_period_end": true,
        "hosted_portal": true,
        "tax_calculation": true,
        "resume_subscription": true,
        "list_invoices": true,
        "list_catalogue": true
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status_detail": "<string>",
      "provider_account_id": "<string>",
      "publishable_key": "<string>",
      "webhook_secret_set": true,
      "last_verified_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "billing_providers_available": true
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Environments

List payment providers

Requires billing:read. The payment gateways this environment can charge through — the gateway you sell your product through, not what UserKit charges you.

One entry per provider the product speaks of, connected or not: the screen is a list of what is possible. connected says a row exists; status says whether it works, and the two are different questions — a connection that exists and is unhealthy is not the same as no connection.

Every status that is not connected names a different repair. That is what it is for: collapsing them into one “broken” ends with a screen telling you to re-paste a credential that is perfect.

`status`	what it means	the repair
`pending`	the keys are stored and the provider has not been asked	run the health check
`connected`	the last check succeeded	none
`invalid_credentials`	the gateway refused the keys	rotate them
`mode_mismatch`	live-mode keys on a test environment, or the reverse	paste the other key, not a new one
`account_not_ready`	the keys work and the account cannot take money: a sign-up never finished, payouts restricted, an account closed	in the gateway’s own dashboard — nothing about the keys will fix it

status_detail carries the gateway’s own sentence, for a person to read. The status says which repair; the detail says why. Never parse it.

Neither secret is ever returned. The secret key is write-only by design, and webhook_secret_set is the one thing this answers about the webhook secret: whether an endpoint has been registered at the provider.

capabilities reports what the gateway can do beyond the minimum every gateway can do, so a screen stops offering an act that would be refused. It is absent when the server has no adapter loaded, because an empty object would read as a claim about the provider rather than about the deployment.

GET

organization

environments

{id}

billing-providers

Error

A valid request URL is required to generate request examples

{
  "providers": [
    {
      "provider": "stripe",
      "connected": true,
      "adapter_available": true,
      "capabilities": {
        "scheduled_plan_change": true,
        "proration": true,
        "cancel_at_period_end": true,
        "hosted_portal": true,
        "tax_calculation": true,
        "resume_subscription": true,
        "list_invoices": true,
        "list_catalogue": true
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status_detail": "<string>",
      "provider_account_id": "<string>",
      "publishable_key": "<string>",
      "webhook_secret_set": true,
      "last_verified_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "billing_providers_available": true
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Authorizations

Authorization

string

header

required

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

Headers

X-Organization-Id

string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing. Absent, the session's default organization answers.

Path Parameters

string<uuid>

required

The environment's id.

Response

The connections.

environment

enum<string>

Available options:

live,

test

providers

object[]

Show child attributes

billing_providers_available

boolean

Whether the server can hold a gateway credential at all. False means connecting would answer 501, whatever is listed above.

Remove a social provider Connect a payment provider

⌘I

Overview

Endpoints

List payment providers

Authorizations

Headers

Path Parameters

Response