Skip to main content
GET
Get Subscription
This endpoint requires a PRO plan or above. If your plan does not include the External Billing API, the request returns 403 with error code external_billing_api.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscription_id
string
required

Integer ID of the subscription.

Example:

"1"

Response

Subscription returned successfully.

id
string

Subscription ID.

Example:

"1"

client_id
string

ID of the client this subscription belongs to.

Example:

"42"

client_name
string

Display name of the client.

Example:

"Acme Corp"

product_id
string

ID of the billing plan/product.

Example:

"7"

product_name
string

Name of the billing plan/product.

Example:

"Starter Plan"

status
enum<string>

Current subscription status.

Available options:
active,
past_due,
blocked,
canceled
Example:

"active"

current_period_start
string<date-time> | null

Start of the current billing period (ISO 8601).

Example:

"2025-01-01T00:00:00"

current_period_end
string<date-time> | null

End of the current billing period (ISO 8601).

Example:

"2025-02-01T00:00:00"

created_at
string<date-time>

When the subscription was created (ISO 8601).

Example:

"2025-01-01T00:00:00"

updated_at
string<date-time>

When the subscription was last updated (ISO 8601).

Example:

"2025-01-15T10:00:00"