Skip to main content
GET
/
api
/
v1
/
subscriptions
/
plans
List subscription plans
curl --request GET \
  --url http://localhost:7701/api/v1/subscriptions/plans \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Basic Monthly",
      "description": "<string>",
      "amount": 2990,
      "currency": "BRL",
      "interval": "monthly",
      "interval_count": 1,
      "trial_period_days": 7,
      "billing_day": 5,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 5,
    "last_page": 1
  }
}

Authorizations

X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Query Parameters

per_page
integer
Example:

15

page
integer
Example:

1

Response

Paginated list of plans

data
object[]
meta
object