v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Plan

Retrieves the collection of Plan resources.

get/plans

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Plan collection

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring nullable

isActiveboolean nullable

aggregateUsagestring nullable

A usage aggregation strategy for metered usage plans e.g. "sum" e.g. "last_during_period" e.g. "max"

amountinteger nullable

price of the plan

billingSchemestring nullable

Describes how to compute the price per period e.g. "per_unit" e.g. "tiered"

createdstring date-time

The date and time the plan is first created

currencystring nullable

descriptionstring nullable

plan description

productIdstring nullable

id for the plan

tiersModestring nullable

Defines if the tier pricing should be graduated or volume e.g. "graduated" e.g. "volume"

transformUsageinteger nullable

Division transformation applied to the reported usage

usageTypestring nullable

Configures how the quantity per period should be determined e.g. "metered" e.g. "licensed"

intervalCountinteger nullable

trialPeriodDaysinteger nullable

Example response

[
  {
    "id": "quickbooks-726",
    "integration": "quickbooks",
    "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
    "isActive": true,
    "aggregateUsage": "sum",
    "amount": 200,
    "billingScheme": "per_unit",
    "currency": "USD",
    "description": "Monthly streaming subscription",
    "productId": "2",
    "tiersMode": "volume",
    "usageType": "metered"
  }
]