README.md

Products

(products)

Overview

Available Operations

• list - List Products
• create - Create Product
• get - Get Product
• update - Update Product
• updateBenefits - Update Product Benefits

list

List products.

Scopes: products:read products:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Operations;

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

$request = new Operations\ProductsListRequest(
    organizationId: [
        '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    ],
);

$responses = $sdk->products->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
$request	Operations\ProductsListRequest	✔️	The request object to use for the request.

Response

?Operations\ProductsListResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

create

Create a product.

Scopes: products:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

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

$request = new Components\ProductCreate(
    name: '<value>',
    recurringInterval: Components\SubscriptionRecurringInterval::Month,
    prices: [
        new Components\ProductPriceFreeCreate(),
    ],
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
);

$response = $sdk->products->create(
    request: $request
);

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

Parameters

Parameter	Type	Required	Description
$request	Components\ProductCreate	✔️	The request object to use for the request.

Response

?Operations\ProductsCreateResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

get

Get a product by ID.

Scopes: products:read products:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

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



$response = $sdk->products->get(
    id: '<value>'
);

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

Parameters

Parameter	Type	Required	Description
id	string	✔️	N/A

Response

?Operations\ProductsGetResponse

Errors

Error Type	Status Code	Content Type
Errors\ResourceNotFound	404	application/json
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

update

Update a product.

Scopes: products:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

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

$productUpdate = new Components\ProductUpdate();

$response = $sdk->products->update(
    id: '<value>',
    productUpdate: $productUpdate

);

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

Parameters

Parameter	Type	Required	Description
id	string	✔️	N/A
productUpdate	Components\ProductUpdate	✔️	N/A

Response

?Operations\ProductsUpdateResponse

Errors

Error Type	Status Code	Content Type
Errors\NotPermitted	403	application/json
Errors\ResourceNotFound	404	application/json
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

updateBenefits

Update benefits granted by a product.

Scopes: products:write

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

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

$productBenefitsUpdate = new Components\ProductBenefitsUpdate(
    benefits: [
        '<value>',
    ],
);

$response = $sdk->products->updateBenefits(
    id: '<value>',
    productBenefitsUpdate: $productBenefitsUpdate

);

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

Parameters

Parameter	Type	Required	Description
id	string	✔️	N/A
productBenefitsUpdate	Components\ProductBenefitsUpdate	✔️	N/A

Response

?Operations\ProductsUpdateBenefitsResponse

Errors

Error Type	Status Code	Content Type
Errors\NotPermitted	403	application/json
Errors\ResourceNotFound	404	application/json
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*