---
title: "Connect Stripe Api Key"
method: POST
path: "/stripe/api-key"
tags: ["Quotes"]
---

# Connect Stripe Api Key

`POST /stripe/api-key`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/stripe/api-key`
- Auth: HTTP bearer

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

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- StripeApiKeyRequest: Connect Stripe with a restricted (or secret) API key. WRITE-ONLY: the key is stored encrypted and never returned by any operation.
  - `api_key` string, required: Stripe restricted or secret key: rk_live_, rk_test_, sk_live_ or sk_test_.

## Response `201`

Successful Response

- ApiResponseBillingPayload
  - `data` BillingPayload, required: An open envelope for one billing result.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)
