Skip to main content
GET
/
api
/
v1
/
subscriptions
/
plans
/
{uuid}
Get a subscription plan
curl --request GET \
  --url http://localhost:7701/api/v1/subscriptions/plans/{uuid} \
  --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"
  }
}

Authorizations

X-API-Key
string
header
required

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

Path Parameters

uuid
string<uuid>
required

Response

Plan found

data
object