Sign in
Space Billing

Update the billing profile

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.

put/api/space/billing_profile

Request body

address_line1string required

The first line of the billing address.

address_line2string

The second line of the billing address.

address_citystring required

The city of the billing address.

address_statestring required

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

address_zipstring required

The postal code of the billing address.

address_countrystring required

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

company_namestring required

The company name to show on statements.

contact_namestring required

The name of the billing contact.

contact_emailstring[] required

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_phonestring required

The phone number of the billing contact.

tax_id_numberstring

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_invoicesboolean

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

Example request

{
  "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"
}

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.