Get the organization's billing subscription
Returns the plan, subscription, customer, and payment method for the org selected by Organization-Id, Connection-Id, or Entity-Id. subscription, customer, and card are null when the org never checked out or the billing system is degraded; hasBillingAccount and hasDefaultPaymentMethod tell the cases apart.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-07-21.
Target organization id (Organization-Id selector).
Target connection id; resolves to its organization.
Platform entity id; resolves to a connection's organization.
Optional source to disambiguate an Entity-Id.
Response
The organization's plan.
FREEGROWTHSTARTERSCALEPREMIUMBilling subscription id, or null if unset.
The billing subscription, or null if unset.
The billing customer, or null if unset.
Payment card on file, or null if none is set.
False only when the organization has no billing subscription or customer at all (it never checked out or opened the portal). True otherwise, even if the billing system could not be reached and the fields above read null.
True when the billing system reports a non-blank primary or card payment source id. False when the organization never checked out, when neither id is present, or when the billing system is degraded. Raw ids never reach the wire.
Successful Response
The request was invalid.
Authentication failed or was missing.
The requested resource was not found.
Validation Error