Sign in
Publishable Keys

Roll Publishable Key

Generate a new Publishable Key and invalidate the old one

post/publishable-keys/roll

Response

OK

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

Unique identifier of the publishable key

valuestring required

The publishable key value, safe for client-side exposure and used in checkout integration

allowedOriginsstring[] required

List of CORS allowed origins for this key, specified as URLs including the protocol

isActiveboolean required

Whether this publishable key is currently active

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "id": "pkey_2Qd6jF5e5bTGCQuQi0u5Uru0k1h",
  "value": "pk_live_a1b2c3d4e5f6g7h8",
  "allowedOrigins": [
    "https://example.com",
    "https://www.example.com"
  ],
  "isActive": true
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.