GET
/
price-plans
curl -X GET \
 /price-plans \
 --header "Authorization: Bearer <token>"
{
  "data": [
    {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "internalName": "Exclusive pricing for partners.",
      "status": "<any>",
      "salesChannel": {},
      "type": "<any>",
      "applyTrial": true,
      "payInAdvance": true,
      "proRata": true,
      "freeUnits": {},
      "billingInterval": "1M",
      "showPricePerInterval": "1M",
      "currencyCode": {},
      "price": {
        "amount": 123,
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00",
        "tenantId": "<string>"
      },
      "custom": true,
      "charge": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "productSetOption": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "product": "<any>",
      "customer": "<any>",
      "inUse": true,
      "checkoutLinkIds": [
        "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
      ]
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Query Parameters

​
page
integer
default:1

The collection page number

​
limit
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
​
product
string
​
product[]
string[]
​
internalName
string
​
internalName[]
string[]
​
customer
string
​
customer[]
string[]

Response

200
application/json

PricePlan collection

The response is of type object.