Skip to main content
GET
Get subscription

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Scopes

openid

OpenID Connect identity.

profile

Name and profile claims.

email

Email address.

offline_access

Refresh token.

Query Parameters

templateSlug
enum<string>
required

Template that composes the mail: http calls a URL that answers with it.

Available options:
http
stateUuid
string<uuid>

Project (deploy state) the subscription covers. Left out, the subscription for the whole workspace.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Get subscription

subscription
Subscription · object
required

The signed-in user's subscription.