Skip to navigation
PlatformSpaceBilling

Retrieve the billing profile

View as MarkdownOpen in Claude

Returns the billing address and contacts for the space. A profile that has never been configured is returned with null fields rather than a 404.

The billing endpoints are available when billing is managed in the space itself, which is the case for every ordinary space: if the Billing section appears in your Dashboard, you can use them. A space purchased through a cloud marketplace, or a suspended or deactivated space, receives 401. A space deactivated for nonpayment keeps them so that its outstanding balance can be settled.

Permissions

Authenticate with a Personal access token whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder’s role in the space is the whole authorization decision.

Authentication

AuthorizationBasic

Personal access token authentication for space-wide administration.

Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project's: it is created from your user menu in the Dashboard, is prefixed pat_, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space.

Example:

Authorization: Basic base64(:pat_...)

Response

The request has succeeded.
typeenum

The object type. Always billing_profile.

Allowed values:
address_line1string or null
The first line of the billing address.
address_line2string or null
The second line of the billing address.
address_citystring or null
The city of the billing address.
address_statestring or null
The state, province, or region of the billing address.
address_zipstring or null
The postal code of the billing address.
address_countrystring or null

The ISO 3166-1 alpha-2 country code of the billing address.

company_namestring or null
The company name that appears on statements.
contact_namestring or null
The name of the billing contact.
contact_emaillist of strings or null
The email addresses billing correspondence is sent to.
contact_phonestring or null
The phone number of the billing contact.
tax_id_numberstring or null
The tax identification number that appears on statements.
monthly_invoicesboolean
Whether a monthly invoice is issued for the space.
tax_id_number_requiredboolean

Whether tax_id_number is required when updating the profile. true on Enterprise spaces.

monthly_invoices_lockedboolean

Whether monthly_invoices is locked on. true on postpay spaces, where monthly invoices cannot be turned off.

Errors

401
Unauthorized Error
500
Internal Server Error