> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/billing-or-profiles.md).

# Billing | Profiles

## Get the default billing profiles where your organization is the supplier or the billed (managed) customer.

> The self-profile (internal billing) has customerId = supplierId. A managed customer also gets the profile of its direct supplier, not those of partner suppliers. A standalone customer without a self-profile gets an empty list.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Billing | Profiles"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"BillingProfile":{"required":["self"],"type":"object","properties":{"customerId":{"type":"integer","format":"int32"},"supplierId":{"type":"integer","format":"int32"},"supplierName":{"type":"string","description":"Name of the billing supplier.","nullable":true},"cycleId":{"type":"integer","format":"int32"},"day":{"type":"integer","format":"int32"},"month":{"type":"integer","format":"int32"},"cronExpression":{"type":"string","nullable":true},"active":{"type":"boolean","description":"Whether billing runs for this profile."},"splitByBillingAddress":{"type":"boolean","description":"Whether invoices are split by billing address."},"id":{"type":"integer","format":"int32"},"cycle":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/billing/profiles":{"get":{"tags":["Billing | Profiles"],"summary":"Get the default billing profiles where your organization is the supplier or the billed (managed) customer.","description":"The self-profile (internal billing) has customerId = supplierId. A managed customer also gets the profile of its direct supplier, not those of partner suppliers. A standalone customer without a self-profile gets an empty list.","parameters":[{"name":"customerId","in":"query","description":"Optional ID of a billed customer to filter by.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The billing profiles.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BillingProfile"}}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /v1/billing/profiles

> Create the self-profile (internal billing) of your organization.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Billing | Profiles"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"CreateBillingProfileRequest":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether billing runs for this profile."},"splitByBillingAddress":{"type":"boolean","description":"Whether invoices are split by billing address."},"day":{"maximum":31,"minimum":1,"type":"integer","description":"Day of the month the billing runs. Default: 2.","format":"int32"},"month":{"maximum":12,"minimum":1,"type":"integer","description":"Month the billing runs for a yearly cycle. Default: 12.","format":"int32"}},"additionalProperties":false,"description":"Body for creating the own (self) profile. The billing cycle is always monthly."},"BillingProfile":{"required":["self"],"type":"object","properties":{"customerId":{"type":"integer","format":"int32"},"supplierId":{"type":"integer","format":"int32"},"supplierName":{"type":"string","description":"Name of the billing supplier.","nullable":true},"cycleId":{"type":"integer","format":"int32"},"day":{"type":"integer","format":"int32"},"month":{"type":"integer","format":"int32"},"cronExpression":{"type":"string","nullable":true},"active":{"type":"boolean","description":"Whether billing runs for this profile."},"splitByBillingAddress":{"type":"boolean","description":"Whether invoices are split by billing address."},"id":{"type":"integer","format":"int32"},"cycle":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/billing/profiles":{"post":{"tags":["Billing | Profiles"],"summary":"Create the self-profile (internal billing) of your organization.","requestBody":{"description":"Initial active, splitByBillingAddress, day and month.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillingProfileRequest"}}}},"responses":{"201":{"description":"The created billing profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingProfile"}}}},"400":{"description":"Bad request: day or month out of range.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict: The self-profile already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Patch active and splitByBillingAddress of a billing profile where your organization is the supplier or the billed customer.

> active can only be changed on the self-profile (customerId = supplierId). A managed customer can only change splitByBillingAddress on its supplier's profile.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Billing | Profiles"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"BillingProfilePatchRequest":{"type":"object","properties":{"patchDocument":{"$ref":"#/components/schemas/JsonPatchDocument_BillingProfilePatch"}},"additionalProperties":false},"JsonPatchDocument_BillingProfilePatch":{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/Operation_BillingProfilePatch"},"nullable":true}},"additionalProperties":false},"Operation_BillingProfilePatch":{"type":"object","properties":{"value":{"nullable":true},"path":{"type":"string","nullable":true},"op":{"type":"string","nullable":true},"from":{"type":"string","nullable":true}},"additionalProperties":false},"BillingProfile":{"required":["self"],"type":"object","properties":{"customerId":{"type":"integer","format":"int32"},"supplierId":{"type":"integer","format":"int32"},"supplierName":{"type":"string","description":"Name of the billing supplier.","nullable":true},"cycleId":{"type":"integer","format":"int32"},"day":{"type":"integer","format":"int32"},"month":{"type":"integer","format":"int32"},"cronExpression":{"type":"string","nullable":true},"active":{"type":"boolean","description":"Whether billing runs for this profile."},"splitByBillingAddress":{"type":"boolean","description":"Whether invoices are split by billing address."},"id":{"type":"integer","format":"int32"},"cycle":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/billing/profiles/{profileId}":{"patch":{"tags":["Billing | Profiles"],"summary":"Patch active and splitByBillingAddress of a billing profile where your organization is the supplier or the billed customer.","description":"active can only be changed on the self-profile (customerId = supplierId). A managed customer can only change splitByBillingAddress on its supplier's profile.","parameters":[{"name":"profileId","in":"path","description":"ID of the billing profile.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The patch request containing the JSON Patch document.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingProfilePatchRequest"}}}},"responses":{"200":{"description":"The updated billing profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingProfile"}}}},"400":{"description":"Bad request: active patched on a profile other than your own, a managed customer patching anything but splitByBillingAddress, or an invalid patch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: No billing profile with this ID exists for your organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hub.equipme.io/development/api-reference-app/billing-or-profiles.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
