Sign in
Product Catalog

List all available add-ons for plan

List all available add-ons for plan.

get/api/v1/plans/{planId}/addons

Path parameters

planIdstring required

Query parameters

includeDeletedboolean

Include deleted plan add-on assignments.

Usage: ?includeDeleted=true

idstring[]

Filter by addon.id attribute.

[
  "01G65Z755AFWAKHE12NY0CQ9FH"
]
keystring[]

Filter by addon.key attribute.

keyVersionobject

Filter by addon.key and addon.version attributes.

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

order'ASC' | 'DESC'

The order direction.

The order direction.

orderBy'id' | 'key' | 'version' | 'created_at' | 'updated_at'

Order by options for plan add-on assignments.

The order by field.

Response

The request has succeeded.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Changes

No recorded changes to this endpoint across all 1 revision of this API.