List PlanTemplates
Changed onRetrieve 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.
Request
- Base URLhttps://api.m3ter.com
- AuthOAuth 2Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/tokenClient credentialsToken URL /oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
Query parameters
Specifies the maximum number of PlanTemplates to retrieve per page.
The nextToken for multi-page retrievals. It is used to fetch the next page of PlanTemplates in a paginated list.
The unique identifiers (UUIDs) of the Products to retrieve associated PlanTemplates.
List of specific PlanTemplate UUIDs to retrieve.
Response
Returns the list of requested PlanTemplates
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
- breaking
the
//////response's property type changed from no type toobjectfor status - breaking
the
//response's property type changed from no type toobjectfor status
- breaking
- breaking
the response's body type changed from no type to
objectfor status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- breaking