---
title: "Create Credit Reason"
method: POST
path: "/organizations/{orgId}/picklists/creditreasons"
tags: ["CreditReason"]
---

# Create Credit Reason

`POST /organizations/{orgId}/picklists/creditreasons`

## Request

- Base URL: `https://api.m3ter.com`
- URL: `https://api.m3ter.com/organizations/{orgId}/picklists/creditreasons`
- Auth: OAuth 2
  - Authorization code: `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize`, token URL `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token`
  - Client credentials, token URL `/oauth/token`
- TypeScript: <https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/picklists/creditreasons/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new Credit Reason for your Organization. When you've created a Credit Reason, it becomes available as a credit type for adding Credit line items to Bills. See [Credits](https://www.m3ter.com/docs/api#tag/Credits).

## Path parameters

- `orgId` string, required

## Request body

- CreditReasonRequest
  - `version` integer: The version number of the entity: - **Create entity:** Not valid for initial insertion of new entity - *do not use for Create*. On initial Create, version is set at 1 and listed in the response. - **Update Entity:** On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
  - `code` string: The short code for the entity.
  - `name` string, required: The name of the entity.
  - `archived` boolean: A Boolean TRUE / FALSE flag indicating whether the entity is archived. An entity can be archived if it is obsolete. * TRUE - the entity is in the archived state. * FALSE - the entity is not in the archived state.

## Response `200`

Return the created Credit Reason

- CreditReasonResponse
  - `id` string, required: The UUID of the entity.
  - `version` integer: The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
  - `code` string: The short code of the data entity.
  - `name` string: The name of the data entity.
  - `archived` boolean: TRUE / FALSE flag indicating whether the data entity is archived. An entity can be archived if it is obsolete.
  - `dtCreated` string, date-time: The DateTime when the credit reason was created *(in ISO-8601 format)*.
  - `dtLastModified` string, date-time: The DateTime when the credit reason was last modified *(in ISO-8601 format)*.
  - `createdBy` string: The id of the user who created this credit reason.
  - `lastModifiedBy` string: The id of the user who last modified this credit reason.

## Other responses

- `4XX`: Error message
- `5XX`: Error message

## Changes

- **2026-10-16** `85c514abc692`: 3 breaking
  - the `allOf[#/components/schemas/AbstractPickListRequest]/allOf[subschema #2]/` request property type changed from no type to `object`
  - the `allOf[#/components/schemas/AbstractPickListResponse]/allOf[subschema #2]/` response's property type changed from no type to `object` for status `200`
  - the `allOf[subschema #3]/` response's property type changed from no type to `object` for status `200`
- **2025-08-01** `9f9e5f3dbde7`: 2 breaking
  - the response property `allOf[#/components/schemas/AbstractPickListResponse]/allOf[#/components/schemas/AbstractResponse]/version` became optional for the status `200`
  - the response property `allOf[#/components/schemas/AbstractResponse]/version` became optional for the status `200`

[Operation history](https://skmtc.dev/m3ter-com/apis/m3ter-api/changes/organizations/:orgId/picklists/creditreasons/post.md)

---

[API](https://skmtc.dev/m3ter-com/apis/m3ter-api.md) - [All operations](https://skmtc.dev/m3ter-com/apis/m3ter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/m3ter-com/apis/m3ter-api/revisions/85c514abc692?raw)