Sign in
latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Discounts

Get an organization discount

get/discounts/{id}

Path parameters

idstring required

The ID of the organization discount

Response

A discount object

idinteger

The ID of the organization discount.

organization_idstring

The ULID of the organization the discount applies to.

type'allowance' | 'startup' | 'enterprise'

The machine name of the discount type.

type_labelstring

The label of the discount type.

status'inactive' | 'active' | 'expired' | 'deactivated'

The status of the discount.

total_monthsinteger nullable

The contract length in months (if applicable).

configobject

The discount type specific configuration.

start_atstring date-time

The start time of the discount period.

end_atstring date-time nullable

The end time of the discount period (if applicable).