Sign in

v1

latestOpenAPI 3.0.02026-08-06363576.8 KB
Plan

Get a list of plans

Lists all plans. Requires a secret key.

get/plans/

Response

Successful operation

idinteger required
namestring required
alternative_namestring
referencestring required
intervalstring required
interval_countinteger required
amountstring required
currencystring required
trial_period_daysinteger
descriptionstring
enabledboolean required
privateboolean required
electronic_onlyboolean required

Example response

{
  "id": 1,
  "name": "Name of the plan.",
  "alternative_name": "A slightly longer name or more descriptive.",
  "reference": "SKU-1",
  "interval": "day|week|month|year",
  "interval_count": 1,
  "amount": "1.0000",
  "currency": "USD",
  "description": "A longer description.",
  "enabled": true,
  "electronic_only": true,
  "payment_processor": {
    "id": 1,
    "name": "Adyen processor",
    "type": "adyen"
  }
}