Clerk API (unofficial showcase)
GET/organizations/{organization_id}/billing/subscription

Retrieve an organization's billing subscription

Retrieves the billing subscription for the specified organization. This includes subscription details, active plans, billing information, and payment status. The subscription contains subscription items which represent the individual plans the organization is subscribed to.

1 parameter
organization_idstringrequired
The ID of the organization whose subscription to retrieve

7 status codes
200A commerce subscription.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:commerce_subscription
idstringrequired
Unique identifier for the commerce subscription.
instance_idstringrequired
The ID of the instance this subscription belongs to.
statusstringrequired
The current status of the subscription.
Allowed:activepast_duecanceledendedabandonedincomplete
payer_idstringrequired
The ID of the payer for this subscription.
created_atintegerrequired
Unix timestamp (milliseconds) of creation.
updated_atintegerrequired
Unix timestamp (milliseconds) of last update.
active_atintegerrequired
Unix timestamp (milliseconds) when the subscription became active.
past_due_atintegerrequired
Unix timestamp (milliseconds) when the subscription became past due.
subscription_itemsarray<object>required
Array of subscription items in this subscription.
next_paymentobjectoptional
Information about the next scheduled payment.
eligible_for_free_trialbooleanoptional
Whether the payer is eligible for a free trial.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Authorization invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
500Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found. A 422 is returned: Invalid request parameters. A 500 is returned: Request was not successful.