gatego API documentation

GetSubscriptions

GET /api/organization/{organizationId}/payment/subscription/

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Path parameters

organizationId integer(int64) Required

organizationId

Responses

• 200

OK
Hide response attributes Show response attributes array[object]
- active boolean
- aggregate_usage string
- amount integer(int64)
- created string(date-time)
- currency string
- current_period_end string(date-time)
- current_period_start string(date-time)
- days_until_due integer(int32)
- id string
- price_id string
- status string
- tiers_mode string
- trial_end string(date-time)
- trial_period_days integer(int64)
- trial_start string(date-time)
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/organization/{organizationId}/payment/subscription/

curl \
 -X GET https://api-dev.gatego.io:443/api/organization/{organizationId}/payment/subscription/ \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "active": true,
    "aggregate_usage": "string",
    "amount": 42,
    "created": "2023-05-04T09:42:00+00:00",
    "currency": "string",
    "current_period_end": "2023-05-04T09:42:00+00:00",
    "current_period_start": "2023-05-04T09:42:00+00:00",
    "days_until_due": 42,
    "id": "string",
    "price_id": "string",
    "status": "string",
    "tiers_mode": "string",
    "trial_end": "2023-05-04T09:42:00+00:00",
    "trial_period_days": 42,
    "trial_start": "2023-05-04T09:42:00+00:00"
  }
]