plans

List plans

Lists billing plans.

get/v1/billing/plans

Request

Query parameters

product_idstring

Filters the response by a Product ID.

page_sizeinteger

The number of items to return in the response.

pageinteger

A non-zero integer which is the start index of the entire list of items to return in the response. The combination of page=1 and page_size=20 returns the first 20 items. The combination of page=2 and page_size=20 returns the next 20 items.

total_requiredboolean

Indicates whether to show the total count in the response.

Headers

Content-Typestring required

The media type. Required for operations with a request body. The value is application/<format>, where the format is json.

Preferstring

The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul>

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that lists billing plans.

total_itemsinteger

The total number of items.

total_pagesinteger

The total number of pages.

Changes

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