Skip to content

Connect Stripe Api Key

POST
/stripe/api-key

Connect Stripe with a restricted API key. REACHES STRIPE to validate it.

Replaces any key already stored for the org. The key is write-only: the response carries the connection id and whether it is a live-mode key, never the key. Products sync within fifteen minutes, or immediately with POST /stripe/sync.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Connect Stripe with a restricted (or secret) API key.

WRITE-ONLY: the key is stored encrypted and never returned by any operation.

object
api_key
required

Stripe restricted or secret key: rk_live_, rk_test_, sk_live_ or sk_test_.

string
>= 10 characters

Responses

201

Successful Response

object
data
required

An open envelope for one billing result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string