List Discounts

List discounts.

Scopes: discounts:read discounts:write

GET /v1/discounts

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Operations;

$sdk = Spaire\Spaire::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
    }
}

200

{
  "items": [
    {
      "amount": 123,
      "currency": "<string>",
      "amounts": {},
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "code": "<string>",
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "max_redemptions": 123,
      "redemptions_count": 123,
      "organization_id": "<string>",
      "products": [
        {
          "metadata": {},
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "trial_interval_count": 123,
          "name": "<string>",
          "description": "<string>",
          "recurring_interval_count": 123,
          "is_recurring": true,
          "is_archived": true,
          "organization_id": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

organization_id · string<uuid4> string<uuid4>[]

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

query · string | null

Filter by name.

page · integer · default: 1

Page number, defaults to 1.

limit · integer · default: 10

Size of a page, defaults to 10. Maximum is 100.

sorting · enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options: created_at, -created_at, name, -name, code, -code, redemptions_count, -redemptions_count, ends_at, -ends_at

Response

200

application/json

Successful Response

items · (DiscountFixedOnceForeverDuration · object | DiscountFixedRepeatDuration · object | DiscountPercentageOnceForeverDuration · object | DiscountPercentageRepeatDuration · object)[] · required

Schema for a fixed amount discount that is applied once or forever.

DiscountFixedOnceForeverDuration

DiscountFixedRepeatDuration

DiscountPercentageOnceForeverDuration

DiscountPercentageRepeatDuration

Show child attributes

pagination · Pagination · object · required

Show child attributes