# Enums

### 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 |

### DisputeInvoiceAction

| Name                      | Description                                                |
| ------------------------- | ---------------------------------------------------------- |
| DO\_NOTHING               | Take no action on invoices when dispute is lost            |
| UNPAY\_AND\_REFUND        | Unpay the invoice and create a refund when dispute is lost |
| CREDIT\_NOTE\_AND\_REFUND | Create a credit note and refund when dispute is lost       |

### DisputeProcessingState

| Name   | Description                  |
| ------ | ---------------------------- |
| OPEN   | Dispute processing is open   |
| CLOSED | Dispute processing is closed |

### DisputeState

| Name | Description                           |
| ---- | ------------------------------------- |
| OPEN | Dispute is open and under review      |
| WON  | Dispute has been won by the merchant  |
| LOST | Dispute has been lost by the merchant |

### DisputeSubscriptionAction

| Name                 | Description                                                 |
| -------------------- | ----------------------------------------------------------- |
| DO\_NOTHING          | Take no action on subscriptions when dispute is lost        |
| DO\_NOT\_AUTO\_RENEW | Disable auto-renewal for subscriptions when dispute is lost |
| CANCEL\_IMMEDIATELY  | Cancel subscriptions immediately when dispute is lost       |

### DocumentTemplateComponentKind

| Name       | Description |
| ---------- | ----------- |
| IMAGE      | Image       |
| HEADING    | Heading     |
| PAGEBREAK  | Pagebreak   |
| PARAGRAPH  | Paragraph   |
| QUOTE      | Quote       |
| SEPARATOR  | Separator   |
| SIGNATURES | Signatures  |
| SPACER     | Spacer      |
| ENTITY     | Entity      |
| ACCOUNT    | Account     |
| HEADER     | Header      |
| FOOTER     | Footer      |

### 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               |
| MERGED              | Merged invoice              |
| QUEUED              | Queued invoice              |
| CONSOLIDATED        | Consolidated 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        |

### PaymentHoldState

| Name      | Description                |
| --------- | -------------------------- |
| SUCCEEDED | Payment hold is successful |
| CANCELLED | Payment hold is cancelled  |

### 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             |

### PaymentProcessingState

| Name       | Description           |
| ---------- | --------------------- |
| SUCCEEDED  | Payment is successful |
| FAILED     | Payment is failed     |
| PENDING    | Payment is pending    |
| PROCESSING | Payment is processing |
| DISPUTED   | Payment is disputed   |

### 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    |
| HIDDEN  | Hidden 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               |
| PERCENTAGE\_DISCOUNT   | Percentage\_discount quote   |
| CREDIT                 | Credit quote                 |
| PRICE\_UPDATE          | Price\_update quote          |
| QUANTITY\_UPDATE       | Quantity\_update quote       |
| FREE\_PERIOD\_DISCOUNT | Free\_period\_discount quote |
| ACTIVATE               | Activate 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       |
| TRIAL\_EXPIRED | Expired trial subscription |
| PENDING        | Pending subscription       |

### TaxType

| Name    | Description        |
| ------- | ------------------ |
| GENERIC | General tax number |
| EIN     | EIN number         |
| GST     | GST number         |
| VAT     | VAT number         |

### 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.   |
| AVERAGE | The billing process will take the average quantity across all records in the billing period. |

### WorkflowJobLogStatus

| Name         | Description  |
| ------------ | ------------ |
| SKIPPED      | Skipped      |
| INITIALIZING | Initializing |
| RUNNING      | Running      |
| COMPLETED    | Completed    |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bunny.com/developer/api-reference/enums.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.