pricingPlanSubscriptions

Get a list of pricing plan subscriptions

Requires the QUOTE.PRICING_PLAN_SUBSCRIPTION.VIEW or PRICING_PLAN_SUBSCRIPTION.VIEW permission. Returns only the types you may view: QUOTE requires QUOTE.PRICING_PLAN_SUBSCRIPTION.VIEW; BILLING and TEMPLATE require PRICING_PLAN_SUBSCRIPTION.VIEW.

get/v{version}/pricing-plan-subscriptions

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/pricing-plan-subscriptions
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

expand[]string[]

The id fields of the resources that are going to be expanded.

customer_idstring

The resource id of the customer.

pricing_plan_subscription_group_idstring

The resource id of the pricing plan subscription group.

referencestring

The reference by which the resource will be filtered. To use this filter, the customer_id must also be present.

typestring

The type of the pricing plan subscription.

variantstring

The variant of the pricing plan subscription.

statusstring

The status of the pricing plan subscription.

statuses[]string[]

The status(es) of the pricing plan subscription.

custom_fieldstring

Filter the response by a custom field value.

start_atstring

Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).

created_atstring

Range filter for the created_at in the pricing plan subscription (ISO-8601).

pageinteger

The page which is going to be shown

limitinteger

The amount of records shown in the list

order_bystring

The parameter by which the response is ordered.

order_directionstring

The order direction by which the response is ordered.

Headers

x-platform-idstring

Platform ID.

Response

OK

pageinteger nullable
limitinteger nullable
total_number_of_pagesinteger nullable

Changes

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