Get Plans

Get PlansServer-sideAdmin

get/projects/{project_id}/subscriptions/plans

Lists all subscription plans.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Project ID.

query Parameters

limit required	integer Limit for the number of elements on the page.
plan_id	integer Subscription plan ID.
offset	integer Number of the element from which the list is generated (the count starts from 0).
external_id	string Plan external ID (32 characters).
group_id	string Group ID the plans are linked to.
product_id	integer Product ID the plans are linked to.
query	string Search query (searches name.en (default locale)).

Responses

200

OK.

Request samples

Response samples

application/json

[{"charge": {"amount": 19.99,
"currency": "USD",
"period": {"type": "month",
"value": 1
},
"prices": [{"amount": 17.99,
"currency": "EUR",
"setup_fee": 1.5
},
{"amount": 2000,
"currency": "JPY",
"setup_fee": 2.5
}
]
},
"description": {"en": "10x more experience!"
},
"expiration": {"type": "day",
"value": 0
},
"external_id": "3b355320",
"grace_period": {"type": "day",
"value": 0
},
"billing_retry": {"value": 1
},
"refund_period": null,
"group_id": null,
"id": 241037,
"localized_name": "Platinum VIP",
"name": {"en": "Platinum VIP",
"fr": "Le VIP-statut platinum"
},
"project_id": 40797,
"status": {"value": "active"
},
"tags": null,
"trial": {"type": "day",
"value": 0
}
},
{"charge": {"amount": 9.99,
"currency": "USD",
"period": {"type": "month",
"value": 1
},
"prices": [{"amount": 8,
"currency": "EUR",
"setup_fee": 1.5
},
{"amount": 1000,
"currency": "JPY",
"setup_fee": 2.5
}
]
},
"description": {"en": "3x more experience!"
},
"expiration": {"type": "day",
"value": 0
},
"external_id": "0fe1b6fc",
"grace_period": {"type": "day",
"value": 0
},
"billing_retry": {"value": 1
},
"refund_period": null,
"group_id": null,
"id": 241038,
"localized_name": "Gold Status",
"name": {"en": "Gold Status",
"fr": "Le statut d’or"
},
"project_id": 40797,
"status": {"value": "active"
},
"tags": null,
"trial": {"type": "day",
"value": 0
}
}
]