Skip to content

README.md

Latest commit

 

History

History
281 lines (189 loc) · 11.5 KB

README.md

File metadata and controls

281 lines (189 loc) · 11.5 KB

Discounts

Overview

Available Operations

list

List discounts.

Scopes: discounts:read discounts: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\DiscountsListRequest(
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
);

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


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

Parameters

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

Response

?Operations\DiscountsListResponse

Errors

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

create

Create a discount.

Scopes: discounts: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\DiscountPercentageOnceForeverDurationCreate(
    duration: Components\DiscountDuration::Once,
    type: Components\DiscountType::Fixed,
    basisPoints: 449604,
    name: '<value>',
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
);

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

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

Parameters

Parameter Type Required Description
$request Components\DiscountFixedOnceForeverDurationCreate|Components\DiscountFixedRepeatDurationCreate|Components\DiscountPercentageOnceForeverDurationCreate|Components\DiscountPercentageRepeatDurationCreate ✔️ The request object to use for the request.

Response

?Operations\DiscountsCreateResponse

Errors

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

get

Get a discount by ID.

Scopes: discounts:read discounts: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->discounts->get(
    id: '<value>'
);

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

Parameters

Parameter Type Required Description
id string ✔️ The discount ID.

Response

?Operations\DiscountsGetResponse

Errors

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

delete

Delete a discount.

Scopes: discounts: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->discounts->delete(
    id: '<value>'
);

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

Parameters

Parameter Type Required Description
id string ✔️ The discount ID.

Response

?Operations\DiscountsDeleteResponse

Errors

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

update

Update a discount.

Scopes: discounts: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();

$discountUpdate = new Components\DiscountUpdate();

$response = $sdk->discounts->update(
    id: '<value>',
    discountUpdate: $discountUpdate

);

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

Parameters

Parameter Type Required Description
id string ✔️ The discount ID.
discountUpdate Components\DiscountUpdate ✔️ N/A

Response

?Operations\DiscountsUpdateResponse

Errors

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