Sign in
Space Billing

Retrieve the billing profile

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.

get/api/space/billing_profile

Response

The request has succeeded.

type'billing_profile' required

The object type. Always billing_profile.

address_line1string nullable required

The first line of the billing address.

address_line2string nullable required

The second line of the billing address.

address_citystring nullable required

The city of the billing address.

address_statestring nullable required

The state, province, or region of the billing address.

address_zipstring nullable required

The postal code of the billing address.

address_countrystring nullable required

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

company_namestring nullable required

The company name that appears on statements.

contact_namestring nullable required

The name of the billing contact.

contact_emailstring[] nullable required

The email addresses billing correspondence is sent to.

contact_phonestring nullable required

The phone number of the billing contact.

tax_id_numberstring nullable required

The tax identification number that appears on statements.

monthly_invoicesboolean required

Whether a monthly invoice is issued for the space.

tax_id_number_requiredboolean required

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

monthly_invoices_lockedboolean required

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

Example response

{
  "type": "billing_profile",
  "address_line1": "1234 Main St",
  "address_line2": "Suite 200",
  "address_city": "Austin",
  "address_state": "TX",
  "address_zip": "78701",
  "address_country": "US",
  "company_name": "Acme Inc",
  "contact_name": "Jane Doe",
  "contact_email": [
    "jane@example.com",
    "billing@example.com"
  ],
  "contact_phone": "+15125550100",
  "tax_id_number": "12-3456789"
}

Changes

Changed in 1 of the 161 revisions of this API.1

Of the 161 revisions, 3 have a changelog that could not be searched.