Claim Seat

POST /v1/customer-seats/claim

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Components;

$sdk = Spaire\Spaire::builder()->build();

$request = new Components\SeatClaim(
    invitationToken: '<value>',
);

$response = $sdk->customerSeats->claimSeat(
    request: $request
);

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

200

{
  "seat": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "member": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "email": "<string>",
      "name": "Jane Doe",
      "external_id": "usr_1337"
    },
    "email": "<string>",
    "customer_email": "<string>",
    "invitation_token_expires_at": "2023-11-07T05:31:56Z",
    "claimed_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z",
    "seat_metadata": {}
  },
  "customer_session_token": "<string>"
}

Body

application/json

invitation_token · string · required

Invitation token to claim the seat

Response

200

application/json

Successful Response

Response after successfully claiming a seat.

seat · CustomerSeat · object · required

The claimed seat

Show child attributes

customer_session_token · string · required

Session token for immediate customer portal access