Subscription

Retrieves a list of subscriptions

Retrieves the collection of Subscription resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

active
boolean
period_starts_at[before]
string
period_starts_at[strictly_before]
string
period_starts_at[after]
string
period_starts_at[strictly_after]
string
period_ends_at[before]
string
period_ends_at[strictly_before]
string
period_ends_at[after]
string
period_ends_at[strictly_after]
string
deleted
boolean
fiscal_id
string
fiscal_id[]
Array of strings
Responses
200

Subscription collection

get/subscriptions
Request samples
Response samples
application/json
[
  • {
    }
]

Retrieves a Subscription resource.

Retrieves a Subscription resource.

SecurityBearer
Request
path Parameters
uuid
required
string

Resource identifier

Responses
200

Subscription resource

404

Resource not found

get/subscriptions/{uuid}
Request samples
Response samples
application/json
{
  • "uuid": "string",
  • "project_codename": "string",
  • "fiscal_id": "string",
  • "active": true,
  • "period_starts_at": "string",
  • "period_ends_at": "string",
  • "auto_renew": true,
  • "auto_renew_at": "string",
  • "limit": 0,
  • "count": 0,
  • "deleted": true
}