Sign in

v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB
Customers

Grant a permission to a customer

Grants a permission to the specified customer. Returns 201 with a Location header pointing to the new permission resource. If expires_at is provided it must be a valid RFC 3339 / ISO 8601 timestamp.

post/customers/{customer_id}/permissions

Path parameters

customer_idstring required

Customer identifier.

Request body

permission_idstring required

Permission identifier to grant. Must be alphanumeric, hyphens, underscores, or dots. Max 256 characters.

expires_atstring date-time nullable

Optional expiration timestamp in RFC 3339 / ISO 8601 format. Omit for a non-expiring permission.

Example request

{
  "permission_id": "premium_access",
  "expires_at": "2026-01-01T00:00:00Z"
}

Response

Permission granted.

object'customer_permission' required
urlstring required
permission_idstring required
expires_atstring date-time nullable required

Example response

{
  "url": "/v4/customers/customer_abc123/permissions/premium_access",
  "permission_id": "premium_access",
  "expires_at": "2026-01-01T00:00:00Z"
}