Enums

Names and values for all enumerations used in Bunny

ApprovalRequestState

Name
Description

PENDING

Pending

APPROVED

Approved

REJECTED

Rejected

BatchMutationName

Name
Description

SUBSCRIPTION_CANCEL

QUOTE_CHANGE_UPDATE

QUOTE_CHANGE_ADD

QUOTE_CHANGE_DELETE

BillingPeriod

Name
Description

ONCE

Billed Once

MONTHLY

Billed Monthly

QUARTERLY

Billed Quarterly

SEMI_ANNUAL

Billed Semi_annual

ANNUAL

Billed Annual

ChargeType

Name
Description

ONE_TIME

One_time charge

RECURRING

Recurring charge

USAGE

Usage charge

CouponDiscountKind

Name
Description

PERCENTAGE

Percentage

AMOUNT

Amount

CreditNoteKind

Name
Description

WRITE_OFF

Write_off credit note

REFUND

Refund credit note

CREDIT

Credit credit note

CreditNoteState

Name
Description

PREPARING

Preparing credit note

DRAFT

Draft credit note

READY

Ready credit note

PARTIALLY_APPLIED

Partially_applied credit note

APPLIED

Applied credit note

CurrencyConversionType

Name
Description

fixed

Convert to base currency via fixed conversion rate

lookup

Convert to base currency using conversion rate lookup

DealKind

Kind of deal

Name
Description

NEW

New business

EXISTING

Existing business

DealOrigin

Origin of deal

Name
Description

SALES

Sales

PORTAL

Portal

SIGNUP

Signup

OTHER

Existing business

DealStageKind

Name
Description

OPEN

OPEN

CLOSED_WON

CLOSED_WON

CLOSED_LOST

CLOSED_LOST

EmailState

Name
Description

queued

Email is being procesed

processing

Email is being procesed

retrying

Email is delayed

delivered

Email was delivered successfully

failed

Email delivery failed

disabled

Outbound emails disabled

FeatureKind

Name
Description

BOOLEAN

True or false

VALUE

Takes a value when used on a plan

QUANTITY

Quantity

GROUP

Feature group

FieldKind

Name
Description

CURRENCY

Currency

INT

Integer

DECIMAL

Decimal

STRING

String

DATE

Date

TIMESTAMP

Timestamp

BOOL

Boolean

RELATION

Relation

MANY_RELATION

Many Relation

ENUM

Enumerable

FinancialAccountType

Name
Description

earned_revenue

Earned revenue

deferred_revenue

Deferred revenue

accounts_receivable

Accounts receivable

cpca

CPCA

tax_payable

Tax payable

conversion_gain

Conversion gain

conversion_loss

Conversion loss

banking_fees

Banking fees

payments

Payments

bad_debt

Bad debt

customer_advances

Customer advances

accounts_payable

Accounts payable

HistogramDataIntervalEnum

Name
Description

DAILY

Monthly interval

MONTHLY

Monthly interval

QUARTERLY

Quarterly interval

SEMIANNUALLY

Semiannually interval

YEARLY

Yearly interval

InvoiceState

Name
Description

NOT_DUE

Not_due invoice

DUE

Due invoice

UNPAID

Unpaid invoice

PAID

Paid invoice

VOIDED

Voided invoice

READY

Ready invoice

FAILED

Failed invoice

PREPARING

Preparing invoice

PROCESSING_PAYMENT

Processing_payment invoice

DRAFT

Draft invoice

JobStatus

Name
Description

running

Job is running

completed

Job completed successfully

failed

Job failed

PayingStatus

Account paying status

Name
Description

FREE

Free

TRIAL

Trial

NOT_PAYING

Free

PAYING

Free

CHURNED_FROM_FREE

Free

CHURNED_FROM_PAYING

Free

PaymentMethodState

Name
Description

UNKNOWN

Payment method has not ben used or unknown state

SUCCESS

Payment method has been succesfully used

FAILED

Payment method has failed during use

PaymentState

Name
Description

UNAPPLIED

Payment is not yet applied

PARTIALLY_APPLIED

Payment is partially applied

APPLIED

Payment is applied

PaymentType

Name
Description

card

Credit or Debit Card payment

wire

Wire transfer payment

ach

ACH payment

other

Uncategorized payment

PlanPricingStyles

Pricing styles options for creating plans

Name
Description

PRICED

Priced

FREE

Free

CONTACT_US

Contact us

PluginParameterKind

Name
Description

SECRET

Secret parameter type

STRING

String parameter type

NUMBER

Number parameter type

BOOLEAN

Boolean parameter type

COPY

Copy parameter type

PluginStatus

Name
Description

VALID

Plugin is valid

INVALID

Plugin is invalid

PriceAdjustmentAction

Controls how the price adjustment is applied

Name
Description

NO_CHANGE

No price adjustment will be applied

PERCENTAGE

Price will be adjusted by a percentage

CATALOG

Price will be adjusted based on catalog prices

PriceAdjustmentTiming

Controls when the price adjustment takes effect

Name
Description

AT_RENEWAL

Price adjustment will be applied at the renewal date

JANUARY

Price adjustment will be applied on January

FEBRUARY

Price adjustment will be applied on February

MARCH

Price adjustment will be applied on March

APRIL

Price adjustment will be applied on April

MAY

Price adjustment will be applied on May

JUNE

Price adjustment will be applied on June

JULY

Price adjustment will be applied on July

AUGUST

Price adjustment will be applied on August

SEPTEMBER

Price adjustment will be applied on September

OCTOBER

Price adjustment will be applied on October

NOVEMBER

Price adjustment will be applied on November

DECEMBER

Price adjustment will be applied on December

PricingModel

Name
Description

FLAT

Flat pricing

TIERED

Tiered pricing

VOLUME

Volume pricing

BANDS

Bands pricing

QuoteChangeKind

Name
Description

SUBSCRIBE

Subscribe quote

UPDATE

Update quote

RENEW

Renew quote

REINSTATE

Reinstate quote

UNSUBSCRIBE

Unsubscribe quote

ADJUSTMENT

Adjustment quote

COUPON

Coupon quote

DISCOUNT

Discount quote

CREDIT

Credit quote

PRICE_UPDATE

Price_update quote

QUANTITY_UPDATE

Quantity_update quote

QuoteState

Name
Description

DRAFT

Draft quote

SHARED

Shared quote

VIEWED

Viewed quote

ACCEPTED

Accepted quote

IN_APPROVAL

In_approval quote

APPROVED

Approved quote

REJECTED

Rejected quote

UNDONE

Undone quote

SsoMode

Name
Description

prompt

prompt

auto

auto

SubscriptionState

Name
Description

ACTIVE

Active subscription

TRIAL

Trial subscription

CANCELED

Cancelled subscription

EXPIRED

Expired subscription

PENDING

Pending subscription

TaxType

Name
Description

GENERIC

General tax number

EIN

EIN number

GST

GST number

VAT

VAT number

TenantProvisioningState

Name
Description

PENDING

Changes have been made to the subscription that have not been applied yet

STARTED

Use this state to trigger a provisioning workflow

FAILED

Tenant provisioning failed

COMPLETED

Tenant provisioning completed

TransactionKind

Name
Description

INVOICE

Invoice transaction

PAYMENT

Payment transaction

CREDIT_NOTE

Credit_note transaction

TrialExpirationAction

Name
Description

CANCEL

Cancel subscription after trial expires

ACTIVATE

Activate subscription after trial expires

UsageCalculation

Name
Description

SUM

The billing process will take the sum of quantity across all records in the billing period.

MAX

The billing process will take the maximum quantity across all records in the billing period.

LAST

The billing process will take the quantity of the last usage entry for the billing period.

WorkflowJobLogStatus

Name
Description

SKIPPED

Skipped

INITIALIZING

Initializing

RUNNING

Running

COMPLETED

Completed

Last updated

Was this helpful?