List Plans

GET

/api/products/{productId}/plans

curl --request GET \
  --url https://example.com/api/products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plans \
  --header 'Authorization: Bearer <token>'

Returns all plans offered under the given product, ordered by price.

Authorizations

• Bearer

Parameters

Path Parameters

productId

required

string format: uuid

The parent product’s identifier.

Responses

200

Plans for the product.

Media type application/json

Array<object>

object

id

string format: uuid

merchantId

string format: uuid

productId

string format: uuid

name

string

nullable

description

string

nullable

price

number format: double

setupFee

number format: double

nullable

frequency

string

Allowed values: OneOff Daily Weekly Fortnightly Monthly Quarterly Yearly

trialDays

integer format: int32

minimumContractMonths

integer format: int32

nullable

cancellationFee

number format: double

nullable

isActive

boolean

isPublic

boolean

createdAt

string format: date-time

updatedAt

string format: date-time

Example

[
  {
    "frequency": "OneOff"
  }
]