Update License Key

Update a license key.

Scopes: license_keys:write

PATCH /v1/license-keys/{id}

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Components;

$sdk = Spaire\Spaire::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$licenseKeyUpdate = new Components\LicenseKeyUpdate();

$response = $sdk->licenseKeys->update(
    id: '<value>',
    licenseKeyUpdate: $licenseKeyUpdate

);

if ($response->licenseKeyRead !== null) {
    // handle response
}

200

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "customer_id": "<string>",
  "customer": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "email": "<string>",
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "<string>",
    "external_id": "usr_1337",
    "type": "individual",
    "locale": "<string>"
  },
  "benefit_id": "<string>",
  "key": "<string>",
  "display_key": "<string>",
  "limit_activations": 123,
  "usage": 123,
  "limit_usage": 123,
  "validations": 123,
  "last_validated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

id · string<uuid4> · required

Body

application/json

status · enum<string> | null

Available options: granted, revoked, disabled

usage · integer · default: 0

limit_activations · integer | null

Required range: 0 < x <= 1000

limit_usage · integer | null

Required range: x > 0

expires_at · string<date-time> | null

Response

200

application/json

Successful Response

id · string<uuid4> · required

The ID of the object.

created_at · string<date-time> · required

Creation timestamp of the object.

modified_at · string<date-time> | null · required

Last modification timestamp of the object.

organization_id · string<uuid4> · required

customer_id · string<uuid4> · required

customer · LicenseKeyCustomer · object · required

Show child attributes

benefit_id · string<uuid4> · required

The benefit ID.

key · string · required

display_key · string · required

status · enum<string> · required

Available options: granted, revoked, disabled

limit_activations · integer | null · required

usage · integer · required

limit_usage · integer | null · required

validations · integer · required

last_validated_at · string<date-time> | null · required

expires_at · string<date-time> | null · required