List pricing periods

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/pricing_periods?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.pricing_periods.pricing_periods_dto.PricingPeriodsDto.SettingsPricingPeriodList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsPricingPeriodList> response = client.pricingPeriods().getSettingsPricingPeriods(
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PricingPeriods.GetSettingsPricingPeriodsAsync(new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.PricingPeriods().GetSettingsPricingPeriods(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "created_by": "<unknown>",
      "created_on": "<string>",
      "description": "<string>",
      "display_name": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "status": "<string>",
      "time_period": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      }
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

GET

settings

pricing_periods

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/pricing_periods?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.pricing_periods.pricing_periods_dto.PricingPeriodsDto.SettingsPricingPeriodList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsPricingPeriodList> response = client.pricingPeriods().getSettingsPricingPeriods(
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PricingPeriods.GetSettingsPricingPeriodsAsync(new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.PricingPeriods().GetSettingsPricingPeriods(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "created_by": "<unknown>",
      "created_on": "<string>",
      "description": "<string>",
      "display_name": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "status": "<string>",
      "time_period": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      }
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Lists the pricing periods on the instance. Pass limit to set the page size, and while pagination.has_more is true pass pagination.next_cursor back as cursor to read the next page. Other fields filter as filter_<field> or filter_<field>_<operator>, and sort orders the results. time_period is null in this response, even when the pricing period has a time period.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit

integer

How many records to return on one page.

Example:

20

cursor

string

The pagination.next_cursor of the previous page, to read the next one.

sort

string

The field to sort by. Prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

A page of pricing periods, under data.

data

object[]

Show child attributes

object

string

pagination

object

Show child attributes

url

string

Guides

API reference

Authorizations

Query Parameters

Response