Skip to navigation
PlatformSpaceBilling

Update the billing profile

View as MarkdownOpen in Claude

Replaces the billing profile. The update writes the whole profile, so send every field you want to keep. contact_email takes an array of one or more addresses.

tax_id_number is required when the profile reports tax_id_number_required: true, which is the case on Enterprise spaces. On a postpay space, monthly_invoices is locked on and false is rejected with monthly_invoices_locked; the profile reports this as monthly_invoices_locked: true so a client does not have to infer it.

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_...)

Request

This endpoint expects an object.
address_line1stringRequired
The first line of the billing address.
address_citystringRequired
The city of the billing address.
address_statestringRequired
The state, province, or region of the billing address.
address_zipstringRequired
The postal code of the billing address.
address_countrystringRequired

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

company_namestringRequired
The company name to show on statements.
contact_namestringRequired
The name of the billing contact.
contact_emaillist of stringsRequired

The email addresses to send billing correspondence to. Must be an array (contact_email_must_be_array) with at least one address (contact_email_missing), each a valid email address (contact_email_address_invalid).

contact_phonestringRequired
The phone number of the billing contact.
address_line2stringOptional
The second line of the billing address.
tax_id_numberstringOptional

The tax identification number to show on statements. Required when the profile reports tax_id_number_required: true, which is the case on Enterprise spaces.

monthly_invoicesbooleanOptionalDefaults to false

Whether to issue a monthly invoice. On a postpay space this is locked on, and false is rejected with monthly_invoices_locked.

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

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error