List plans

GET

/api/v1/plans

const url = 'https://example.com/api/v1/plans';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/plans \
  --header 'x-api-key: <x-api-key>'

Authorizations

x-api-key

Parameters

Query Parameters

activeOnly

string

Responses

200

application/json

Array<object>

object

required

string

stripeProductId

required

string

stripePriceId

required

string

name

required

string

amount

required

Smallest currency unit (cents) — never floating point

number

currency

required

string

interval

required

string

Allowed values: year month

active

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

[
  {
    "interval": "year"
  }
]