Create a credit unit

Idempotency Supported

Creates a new credit unit in the active status.

Sample Request

create a credit unit

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/credit_units

Input Parameters

required, string, max chars=50

Unique identifier for the credit unit. Must be unique across the site.

name

required, string, max chars=50

Internal display name for the credit unit. Must be unique across the site.

is_unlimited

required, boolean

Indicates whether the credit unit allows unlimited overdraft consumption. When true, grace consumption continues without a cap after the allocated grants are exhausted. When false, provide overdraft_amount to cap the grace consumption.

overdraft_amount

optional, string, max chars=50

The amount up to which grace consumption is allowed after the allocated grants are exhausted. A positive decimal value that applies only when is_unlimited is false.

external_name

optional, string, max chars=50

Customer-facing display name for the credit unit. Must be unique across the site. Defaults to name when omitted.

Returns

credit_unit

Credit unit object

Resource object representing credit_unit