Skip to main content

kobana billing organization

Get current organization

Commands of kobana billing organization. Every global option (Global options) applies here.

CommandHTTPDescription
organizationGET /v1/organizationGet current organization
organization updatePATCH /v1/organizationUpdate current organization

organization​

Get current organization

kobana billing organization [OPTIONS] [COMMAND]

GET /v1/organization

Returns the data of the organization the authenticated token belongs to. There is no :id parameter — the organization is always resolved from the API key.

Responses

HTTPDescription
200Current organization detail.
404Resource not found in the current organization.

organization update​

Update current organization

kobana billing organization update [OPTIONS]

PATCH /v1/organization

Updates the profile the authenticated organization controls: addresses and custom_metadata (null keeps the current value). Identity (id, external_id, status, document) and the fields mirrored from the Kobana Account (name, email, phone) cannot be changed through this endpoint: if sent, they are ignored — to correct them, change the Kobana Account. Commercial fields (such as courtesy and bypass_subscription) are refused with 403.

Request body

NameTypeRequiredDescription
addressesarray<object>noList of organization addresses.
custom_metadataobjectnoArbitrary client-defined metadata (key/value). null is ignored and keeps the current value.

More fields and nested objects: kobana schema billing.organization.update.

Responses

HTTPDescription
200Organization updated.
400Request body failed validation.
404Resource not found in the current organization.
422Request body failed validation.