Mint API key

Mint a Merge Gateway API key scoped to this customer. The raw key is returned ONCE, in key. Requires an organization-level access key. Max 5 keys per customer.

Authentication

AuthorizationBearer

Your production key sent as a bearer token.

Path parameters

customer_idstringRequired

Request

This endpoint expects an object.

namestringOptional

spending_limitdoubleOptional

Per-key spend cap over reset_period, independent of the customer’s budget.

reset_periodenumOptional

Requires spending_limit.

Allowed values:

rate_limit_rpmintegerOptional

rate_limit_tpmintegerOptional

Response

Successful Response

keystring

The raw secret. Shown only in this response; store it now.

idstringOptional

Key identifier; pass to DELETE.

customerstringOptional

The customer this key is bound to (immutable).

namestring or nullOptional

key_prefixstringOptional

is_activebooleanOptional

spending_limitdouble or nullOptional

reset_periodstring or nullOptional

rate_limit_rpminteger or nullOptional

rate_limit_tpminteger or nullOptional

created_atdatetime or nullOptional

expires_atdatetime or nullOptional

$	curl -X POST https://api-gateway.merge.dev/v1/customers/customer_id/api-keys \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"key": "mg_Ay-PjqVBssKCHrPfZMxWQ9pQEFxXCrgVVs8qSPi8fa8",
3	"id": "3c9e6679742540de944be07fc1f90ae7",
4	"customer": "9f8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
5	"name": "Acme production",
6	"key_prefix": "mg_abc123",
7	"is_active": true,
8	"spending_limit": 100,
9	"reset_period": "monthly",
10	"rate_limit_rpm": 600,
11	"rate_limit_tpm": 90000,
12	"created_at": "2024-01-15T09:30:00Z",
13	"expires_at": "2024-01-15T09:30:00Z"
14	}