README.md

Subscriptions

(subscriptions)

Overview

Available Operations

• list - List Subscriptions
• export - Export Subscriptions
• get - Get Subscription
• update - Update Subscription
• revoke - Revoke Subscription

list

List subscriptions.

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

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


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

Parameters

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

Response

?Operations\SubscriptionsListResponse

Errors

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

export

Export subscriptions as a CSV file.

Scopes: subscriptions:read subscriptions: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->subscriptions->export(
    organizationId: [
        '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    ]
);

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

Parameters

Parameter	Type	Required	Description
organizationId	string|array|null	➖	Filter by organization ID.

Response

?Operations\SubscriptionsExportResponse

Errors

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

get

Get a subscription by ID.

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

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

Parameters

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

Response

?Operations\SubscriptionsGetResponse

Errors

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

update

Update a subscription.

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



$response = $sdk->subscriptions->update(
    id: '<value>',
    subscriptionUpdate: new Components\SubscriptionRevoke()

);

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

Parameters

Parameter	Type	Required	Description
id	string	✔️	The subscription ID.
subscriptionUpdate	Components\SubscriptionUpdateProduct|Components\SubscriptionCancel|Components\SubscriptionRevoke	✔️	N/A

Response

?Operations\SubscriptionsUpdateResponse

Errors

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

revoke

Revoke a subscription, i.e cancel immediately.

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

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

Parameters

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

Response

?Operations\SubscriptionsRevokeResponse

Errors

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