Sign in
PlanTemplate

List PlanTemplate

Retrieve a list of PlanTemplates.

This endpoint enables you to retrieve a paginated list of PlanTemplates belonging to a specific Organization, identified by its UUID. You can filter the list by PlanTemplate IDs or Product IDs for more focused retrieval.

get/organizations/{orgId}/plantemplates

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

Specifies the maximum number of PlanTemplates to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of PlanTemplates in a paginated list.

productIdstring

The unique identifiers (UUIDs) of the Products to retrieve associated PlanTemplates.

idsstring[]

List of specific PlanTemplate UUIDs to retrieve.

Response

Returns the list of requested PlanTemplates

nextTokenstring

Example response

{
  "data": [
    {
      "id": "string",
      "version": 1,
      "customFields": {
        "example1": 123,
        "example2": "string"
      },
      "productId": "string",
      "name": "string",
      "currency": "USD",
      "standingCharge": 0,
      "standingChargeDescription": "string",
      "standingChargeInterval": 1,
      "standingChargeOffset": 364,
      "billFrequencyInterval": 1,
      "billFrequency": "DAILY",
      "ordinal": 0,
      "code": "string",
      "minimumSpend": 0,
      "minimumSpendDescription": "string",
      "standingChargeBillInAdvance": true,
      "minimumSpendBillInAdvance": false
    }
  ]
}

Changes

Changed in 2 of the 10 revisions of this API.222

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b512See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog