Sign in
latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-14249167721.0 KB

75df3a43fcb2

Billing

Create a custom billing price

Creates a custom price for a billing plan. Custom prices allow you to offer different pricing to specific customers while maintaining the same plan structure.

post/billing/prices

Request body

plan_idstring required

The ID of the plan this price belongs to.

currencystring

The currency code (e.g., "USD"). Defaults to USD.

amountinteger nullable required

The monthly amount in cents. Use 0 for a complimentary price. Positive amounts must be at least $1 (100 cents).

annual_monthly_amountinteger nullable

The monthly amount in cents when billed annually. Use 0 for a complimentary price. Positive amounts must be at least $1 (100 cents).

descriptionstring

An optional description for this custom price.

supported_billing_periods'month' | 'annual' | 'both'

Which billing periods this price supports. Inferred from amounts if omitted.

Response

A billing price.

object'commerce_price' required

String representing the object's type. Objects of the same type share the same value.

idstring required

Unique identifier for the price.

plan_idstring required

Unique identifier for the associated plan.

instance_idstring required

Unique identifier for the instance.

currencystring required

The currency code (e.g., "USD").

currency_symbolstring required

The currency symbol (e.g., "$").

amountinteger required

The amount in cents for the price.

annual_monthly_amountinteger required

The monthly amount in cents when billed annually.

descriptionstring nullable

The description of the price.

is_defaultboolean required

Whether this price is the default price for its plan.

created_atinteger required

Unix timestamp (milliseconds) of creation.

supported_billing_periods'month' | 'annual' | 'both' required

Which billing periods this price supports.