orb-billing 1.0.1 → 1.19.5

package/docs/models/operations/updatecustomerexternalidrequest.md

@@ -0,0 +1,9 @@
+# UpdateCustomerExternalIdRequest
+
+
+## Fields
+
+| Field                                                      | Type                                                       | Required                                                   | Description                                                |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `editCustomer`                                             | [shared.EditCustomer](../../models/shared/editcustomer.md) | :heavy_minus_sign:                                         | N/A                                                        |
+| `externalCustomerId`                                       | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |

package/docs/models/operations/updatecustomerexternalidresponse.md

@@ -0,0 +1,18 @@
+# UpdateCustomerExternalIdResponse
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `fourHundredError`                                                                           | *any*                                                                                        | :heavy_minus_sign:                                                                           | Bad Request                                                                                  |
+| `fourHundredAndOneError`                                                                     | [shared.FourHundredAndOneError](../../models/shared/fourhundredandoneerror.md)               | :heavy_minus_sign:                                                                           | Unauthorized                                                                                 |
+| `fourHundredAndFourError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Not Found                                                                                    |
+| `fourHundredAndNineError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Conflict                                                                                     |
+| `fourHundredAndThirteenError`                                                                | *any*                                                                                        | :heavy_minus_sign:                                                                           | Request Entity Too Large                                                                     |
+| `fourHundredAndTwentyNineError`                                                              | [shared.FourHundredAndTwentyNineError](../../models/shared/fourhundredandtwentynineerror.md) | :heavy_minus_sign:                                                                           | Too Many Requests                                                                            |
+| `fiveHundredError`                                                                           | [shared.FiveHundredError](../../models/shared/fivehundrederror.md)                           | :heavy_minus_sign:                                                                           | Internal Server Error                                                                        |
+| `contentType`                                                                                | *string*                                                                                     | :heavy_check_mark:                                                                           | HTTP response content type for this operation                                                |
+| `customer`                                                                                   | [shared.Customer](../../models/shared/customer.md)                                           | :heavy_minus_sign:                                                                           | OK                                                                                           |
+| `statusCode`                                                                                 | *number*                                                                                     | :heavy_check_mark:                                                                           | HTTP response status code for this operation                                                 |
+| `rawResponse`                                                                                | [AxiosResponse](https://axios-http.com/docs/res_schema)                                      | :heavy_minus_sign:                                                                           | Raw HTTP response; suitable for custom response parsing                                      |

package/docs/models/operations/updatecustomerrequest.md

@@ -0,0 +1,9 @@
+# UpdateCustomerRequest
+
+
+## Fields
+
+| Field                                                      | Type                                                       | Required                                                   | Description                                                |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `editCustomer`                                             | [shared.EditCustomer](../../models/shared/editcustomer.md) | :heavy_minus_sign:                                         | N/A                                                        |
+| `customerId`                                               | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |

package/docs/models/operations/updatecustomerresponse.md

@@ -0,0 +1,18 @@
+# UpdateCustomerResponse
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `fourHundredError`                                                                           | *any*                                                                                        | :heavy_minus_sign:                                                                           | Bad Request                                                                                  |
+| `fourHundredAndOneError`                                                                     | [shared.FourHundredAndOneError](../../models/shared/fourhundredandoneerror.md)               | :heavy_minus_sign:                                                                           | Unauthorized                                                                                 |
+| `fourHundredAndFourError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Not Found                                                                                    |
+| `fourHundredAndNineError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Conflict                                                                                     |
+| `fourHundredAndThirteenError`                                                                | *any*                                                                                        | :heavy_minus_sign:                                                                           | Request Entity Too Large                                                                     |
+| `fourHundredAndTwentyNineError`                                                              | [shared.FourHundredAndTwentyNineError](../../models/shared/fourhundredandtwentynineerror.md) | :heavy_minus_sign:                                                                           | Too Many Requests                                                                            |
+| `fiveHundredError`                                                                           | [shared.FiveHundredError](../../models/shared/fivehundrederror.md)                           | :heavy_minus_sign:                                                                           | Internal Server Error                                                                        |
+| `contentType`                                                                                | *string*                                                                                     | :heavy_check_mark:                                                                           | HTTP response content type for this operation                                                |
+| `customer`                                                                                   | [shared.Customer](../../models/shared/customer.md)                                           | :heavy_minus_sign:                                                                           | OK                                                                                           |
+| `statusCode`                                                                                 | *number*                                                                                     | :heavy_check_mark:                                                                           | HTTP response status code for this operation                                                 |
+| `rawResponse`                                                                                | [AxiosResponse](https://axios-http.com/docs/res_schema)                                      | :heavy_minus_sign:                                                                           | Raw HTTP response; suitable for custom response parsing                                      |

package/docs/models/operations/updatefixedfeequantityrequest.md

@@ -0,0 +1,9 @@
+# UpdateFixedFeeQuantityRequest
+
+
+## Fields
+
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `fixedFeeQuantityChange`                                                       | [shared.FixedFeeQuantityChange](../../models/shared/fixedfeequantitychange.md) | :heavy_minus_sign:                                                             | N/A                                                                            |
+| `subscriptionId`                                                               | *string*                                                                       | :heavy_check_mark:                                                             | N/A                                                                            |

package/docs/models/operations/updatefixedfeequantityresponse.md

@@ -0,0 +1,18 @@
+# UpdateFixedFeeQuantityResponse
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `fourHundredError`                                                                           | *any*                                                                                        | :heavy_minus_sign:                                                                           | Bad Request                                                                                  |
+| `fourHundredAndOneError`                                                                     | [shared.FourHundredAndOneError](../../models/shared/fourhundredandoneerror.md)               | :heavy_minus_sign:                                                                           | Unauthorized                                                                                 |
+| `fourHundredAndFourError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Not Found                                                                                    |
+| `fourHundredAndNineError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Conflict                                                                                     |
+| `fourHundredAndThirteenError`                                                                | *any*                                                                                        | :heavy_minus_sign:                                                                           | Request Entity Too Large                                                                     |
+| `fourHundredAndTwentyNineError`                                                              | [shared.FourHundredAndTwentyNineError](../../models/shared/fourhundredandtwentynineerror.md) | :heavy_minus_sign:                                                                           | Too Many Requests                                                                            |
+| `fiveHundredError`                                                                           | [shared.FiveHundredError](../../models/shared/fivehundrederror.md)                           | :heavy_minus_sign:                                                                           | Internal Server Error                                                                        |
+| `contentType`                                                                                | *string*                                                                                     | :heavy_check_mark:                                                                           | HTTP response content type for this operation                                                |
+| `statusCode`                                                                                 | *number*                                                                                     | :heavy_check_mark:                                                                           | HTTP response status code for this operation                                                 |
+| `rawResponse`                                                                                | [AxiosResponse](https://axios-http.com/docs/res_schema)                                      | :heavy_minus_sign:                                                                           | Raw HTTP response; suitable for custom response parsing                                      |
+| `subscription`                                                                               | [shared.Subscription](../../models/shared/subscription.md)                                   | :heavy_minus_sign:                                                                           | OK                                                                                           |

package/docs/models/operations/updateplanexternalrequest.md

@@ -0,0 +1,9 @@
+# UpdatePlanExternalRequest
+
+
+## Fields
+
+| Field                                              | Type                                               | Required                                           | Description                                        |
+| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
+| `editPlan`                                         | [shared.EditPlan](../../models/shared/editplan.md) | :heavy_minus_sign:                                 | N/A                                                |
+| `externalPlanId`                                   | *string*                                           | :heavy_check_mark:                                 | N/A                                                |

package/docs/models/operations/updateplanexternalresponse.md

@@ -0,0 +1,18 @@
+# UpdatePlanExternalResponse
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `fourHundredError`                                                                           | *any*                                                                                        | :heavy_minus_sign:                                                                           | Bad Request                                                                                  |
+| `fourHundredAndOneError`                                                                     | [shared.FourHundredAndOneError](../../models/shared/fourhundredandoneerror.md)               | :heavy_minus_sign:                                                                           | Unauthorized                                                                                 |
+| `fourHundredAndFourError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Not Found                                                                                    |
+| `fourHundredAndNineError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Conflict                                                                                     |
+| `fourHundredAndThirteenError`                                                                | *any*                                                                                        | :heavy_minus_sign:                                                                           | Request Entity Too Large                                                                     |
+| `fourHundredAndTwentyNineError`                                                              | [shared.FourHundredAndTwentyNineError](../../models/shared/fourhundredandtwentynineerror.md) | :heavy_minus_sign:                                                                           | Too Many Requests                                                                            |
+| `fiveHundredError`                                                                           | [shared.FiveHundredError](../../models/shared/fivehundrederror.md)                           | :heavy_minus_sign:                                                                           | Internal Server Error                                                                        |
+| `contentType`                                                                                | *string*                                                                                     | :heavy_check_mark:                                                                           | HTTP response content type for this operation                                                |
+| `plan`                                                                                       | [shared.Plan](../../models/shared/plan.md)                                                   | :heavy_minus_sign:                                                                           | OK                                                                                           |
+| `statusCode`                                                                                 | *number*                                                                                     | :heavy_check_mark:                                                                           | HTTP response status code for this operation                                                 |
+| `rawResponse`                                                                                | [AxiosResponse](https://axios-http.com/docs/res_schema)                                      | :heavy_minus_sign:                                                                           | Raw HTTP response; suitable for custom response parsing                                      |

package/docs/models/operations/updateplanrequest.md

@@ -0,0 +1,9 @@
+# UpdatePlanRequest
+
+
+## Fields
+
+| Field                                              | Type                                               | Required                                           | Description                                        |
+| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
+| `editPlan`                                         | [shared.EditPlan](../../models/shared/editplan.md) | :heavy_minus_sign:                                 | N/A                                                |
+| `planId`                                           | *string*                                           | :heavy_check_mark:                                 | N/A                                                |

package/docs/models/operations/updateplanresponse.md

@@ -0,0 +1,18 @@
+# UpdatePlanResponse
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `fourHundredError`                                                                           | *any*                                                                                        | :heavy_minus_sign:                                                                           | Bad Request                                                                                  |
+| `fourHundredAndOneError`                                                                     | [shared.FourHundredAndOneError](../../models/shared/fourhundredandoneerror.md)               | :heavy_minus_sign:                                                                           | Unauthorized                                                                                 |
+| `fourHundredAndFourError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Not Found                                                                                    |
+| `fourHundredAndNineError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Conflict                                                                                     |
+| `fourHundredAndThirteenError`                                                                | *any*                                                                                        | :heavy_minus_sign:                                                                           | Request Entity Too Large                                                                     |
+| `fourHundredAndTwentyNineError`                                                              | [shared.FourHundredAndTwentyNineError](../../models/shared/fourhundredandtwentynineerror.md) | :heavy_minus_sign:                                                                           | Too Many Requests                                                                            |
+| `fiveHundredError`                                                                           | [shared.FiveHundredError](../../models/shared/fivehundrederror.md)                           | :heavy_minus_sign:                                                                           | Internal Server Error                                                                        |
+| `contentType`                                                                                | *string*                                                                                     | :heavy_check_mark:                                                                           | HTTP response content type for this operation                                                |
+| `plan`                                                                                       | [shared.Plan](../../models/shared/plan.md)                                                   | :heavy_minus_sign:                                                                           | OK                                                                                           |
+| `statusCode`                                                                                 | *number*                                                                                     | :heavy_check_mark:                                                                           | HTTP response status code for this operation                                                 |
+| `rawResponse`                                                                                | [AxiosResponse](https://axios-http.com/docs/res_schema)                                      | :heavy_minus_sign:                                                                           | Raw HTTP response; suitable for custom response parsing                                      |

package/docs/models/operations/voidinvoicerequest.md

@@ -0,0 +1,8 @@
+# VoidInvoiceRequest
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `invoiceId`        | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/operations/voidinvoiceresponse.md

@@ -0,0 +1,18 @@
+# VoidInvoiceResponse
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `fourHundredError`                                                                           | *any*                                                                                        | :heavy_minus_sign:                                                                           | Bad Request                                                                                  |
+| `fourHundredAndOneError`                                                                     | [shared.FourHundredAndOneError](../../models/shared/fourhundredandoneerror.md)               | :heavy_minus_sign:                                                                           | Unauthorized                                                                                 |
+| `fourHundredAndFourError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Not Found                                                                                    |
+| `fourHundredAndNineError`                                                                    | *any*                                                                                        | :heavy_minus_sign:                                                                           | Conflict                                                                                     |
+| `fourHundredAndThirteenError`                                                                | *any*                                                                                        | :heavy_minus_sign:                                                                           | Request Entity Too Large                                                                     |
+| `fourHundredAndTwentyNineError`                                                              | [shared.FourHundredAndTwentyNineError](../../models/shared/fourhundredandtwentynineerror.md) | :heavy_minus_sign:                                                                           | Too Many Requests                                                                            |
+| `fiveHundredError`                                                                           | [shared.FiveHundredError](../../models/shared/fivehundrederror.md)                           | :heavy_minus_sign:                                                                           | Internal Server Error                                                                        |
+| `contentType`                                                                                | *string*                                                                                     | :heavy_check_mark:                                                                           | HTTP response content type for this operation                                                |
+| `invoice`                                                                                    | [shared.Invoice](../../models/shared/invoice.md)                                             | :heavy_minus_sign:                                                                           | OK                                                                                           |
+| `statusCode`                                                                                 | *number*                                                                                     | :heavy_check_mark:                                                                           | HTTP response status code for this operation                                                 |
+| `rawResponse`                                                                                | [AxiosResponse](https://axios-http.com/docs/res_schema)                                      | :heavy_minus_sign:                                                                           | Raw HTTP response; suitable for custom response parsing                                      |

package/docs/models/shared/accountingprovider.md

@@ -0,0 +1,9 @@
+# AccountingProvider
+
+
+## Fields
+
+| Field                                                                                   | Type                                                                                    | Required                                                                                | Description                                                                             |
+| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
+| `externalProviderId`                                                                    | *string*                                                                                | :heavy_check_mark:                                                                      | N/A                                                                                     |
+| `providerType`                                                                          | [AccountingProviderProviderType](../../models/shared/accountingproviderprovidertype.md) | :heavy_check_mark:                                                                      | N/A                                                                                     |

package/docs/models/shared/accountingproviderconfig.md

@@ -0,0 +1,9 @@
+# AccountingProviderConfig
+
+
+## Fields
+
+| Field                | Type                 | Required             | Description          |
+| -------------------- | -------------------- | -------------------- | -------------------- |
+| `externalProviderId` | *string*             | :heavy_check_mark:   | N/A                  |
+| `providerType`       | *string*             | :heavy_check_mark:   | N/A                  |

package/docs/models/shared/accountingproviderprovidertype.md

@@ -0,0 +1,9 @@
+# AccountingProviderProviderType
+
+
+## Values
+
+| Name         | Value        |
+| ------------ | ------------ |
+| `Quickbooks` | quickbooks   |
+| `Netsuite`   | netsuite     |

package/docs/models/shared/accountingsyncconfiguration.md

@@ -0,0 +1,9 @@
+# AccountingSyncConfiguration
+
+
+## Fields
+
+| Field                                                             | Type                                                              | Required                                                          | Description                                                       |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `accountingProviders`                                             | [AccountingProvider](../../models/shared/accountingprovider.md)[] | :heavy_check_mark:                                                | N/A                                                               |
+| `excluded`                                                        | *boolean*                                                         | :heavy_check_mark:                                                | N/A                                                               |

package/docs/models/shared/addamendmentcreditledgerentryrequestparams.md

@@ -0,0 +1,12 @@
+# AddAmendmentCreditLedgerEntryRequestParams
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement or void operations.                                                                                                               |
+| `blockId`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                     | The ID of the block to reverse a decrement from.                                                                                                                                                                       |
+| `description`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc. |
+| `entryType`                                                                                                                                                                                                            | [AddAmendmentCreditLedgerEntryRequestParamsEntryType](../../models/shared/addamendmentcreditledgerentryrequestparamsentrytype.md)                                                                                      | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |
+| `metadata`                                                                                                                                                                                                             | [AddAmendmentCreditLedgerEntryRequestParamsMetadata](../../models/shared/addamendmentcreditledgerentryrequestparamsmetadata.md)                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                     | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                          |

package/docs/models/shared/addamendmentcreditledgerentryrequestparamsentrytype.md

@@ -0,0 +1,8 @@
+# AddAmendmentCreditLedgerEntryRequestParamsEntryType
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `Amendment` | amendment   |

package/docs/models/shared/addamendmentcreditledgerentryrequestparamsmetadata.md

@@ -0,0 +1,9 @@
+# AddAmendmentCreditLedgerEntryRequestParamsMetadata
+
+User-specified key/value pairs for the ledger entry resource.
+
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/adddecrementcreditledgerentryrequestparams.md

@@ -0,0 +1,11 @@
+# AddDecrementCreditLedgerEntryRequestParams
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.                                                                                                        |
+| `description`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc. |
+| `entryType`                                                                                                                                                                                                            | [AddDecrementCreditLedgerEntryRequestParamsEntryType](../../models/shared/adddecrementcreditledgerentryrequestparamsentrytype.md)                                                                                      | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |
+| `metadata`                                                                                                                                                                                                             | [AddDecrementCreditLedgerEntryRequestParamsMetadata](../../models/shared/adddecrementcreditledgerentryrequestparamsmetadata.md)                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                     | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                          |

package/docs/models/shared/adddecrementcreditledgerentryrequestparamsentrytype.md

@@ -0,0 +1,8 @@
+# AddDecrementCreditLedgerEntryRequestParamsEntryType
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `Decrement` | decrement   |

package/docs/models/shared/adddecrementcreditledgerentryrequestparamsmetadata.md

@@ -0,0 +1,9 @@
+# AddDecrementCreditLedgerEntryRequestParamsMetadata
+
+User-specified key/value pairs for the ledger entry resource.
+
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/addeditpriceintervalparams.md

@@ -0,0 +1,9 @@
+# AddEditPriceIntervalParams
+
+
+## Fields
+
+| Field                                                                       | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `add`                                                                       | [AddPriceIntervalParams](../../models/shared/addpriceintervalparams.md)[]   | :heavy_minus_sign:                                                          | A list of price intervals to add to the subscription.                       |
+| `edit`                                                                      | [EditPriceIntervalParams](../../models/shared/editpriceintervalparams.md)[] | :heavy_minus_sign:                                                          | A list of price intervals to edit on the subscription.                      |

package/docs/models/shared/addexpirationchangecreditledgerentryrequestparams.md

@@ -0,0 +1,14 @@
+# AddExpirationChangeCreditLedgerEntryRequestParams
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.                                                                                                        |
+| `blockId`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | The ID of the block affected by an expiration_change, used to differentiate between multiple blocks with the same `expiry_date`.                                                                                       |
+| `description`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc. |
+| `entryType`                                                                                                                                                                                                            | [AddExpirationChangeCreditLedgerEntryRequestParamsEntryType](../../models/shared/addexpirationchangecreditledgerentryrequestparamsentrytype.md)                                                                        | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |
+| `expiryDate`                                                                                                                                                                                                           | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                     | A future date (specified in YYYY-MM-DD format) that identifies the origination credit block to expire                                                                                                                  |
+| `metadata`                                                                                                                                                                                                             | [AddExpirationChangeCreditLedgerEntryRequestParamsMetadata](../../models/shared/addexpirationchangecreditledgerentryrequestparamsmetadata.md)                                                                          | :heavy_minus_sign:                                                                                                                                                                                                     | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                          |
+| `targetExpiryDate`                                                                                                                                                                                                     | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                     | A future date (specified in YYYY-MM-DD format) used for expiration change, denoting when credits transferred (as part of a partial block expiration) should expire.                                                    |

package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsentrytype.md

@@ -0,0 +1,8 @@
+# AddExpirationChangeCreditLedgerEntryRequestParamsEntryType
+
+
+## Values
+
+| Name               | Value              |
+| ------------------ | ------------------ |
+| `ExpirationChange` | expiration_change  |

package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsmetadata.md

@@ -0,0 +1,9 @@
+# AddExpirationChangeCreditLedgerEntryRequestParamsMetadata
+
+User-specified key/value pairs for the ledger entry resource.
+
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/addincrementcreditledgerentryrequestparams.md

@@ -0,0 +1,15 @@
+# AddIncrementCreditLedgerEntryRequestParams
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                            | Type                                                                                                                                                                                                                             | Required                                                                                                                                                                                                                         | Description                                                                                                                                                                                                                      |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `amount`                                                                                                                                                                                                                         | *any*                                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                               | The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.                                                                                                                  |
+| `description`                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                               | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc.           |
+| `effectiveDate`                                                                                                                                                                                                                  | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                               | A future date (specified in YYYY-MM-DD format) that denotes when this credit balance should become available for use.                                                                                                            |
+| `entryType`                                                                                                                                                                                                                      | [AddIncrementCreditLedgerEntryRequestParamsEntryType](../../models/shared/addincrementcreditledgerentryrequestparamsentrytype.md)                                                                                                | :heavy_check_mark:                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                              |
+| `expiryDate`                                                                                                                                                                                                                     | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                               | A future date (specified in YYYY-MM-DD format) that denotes when this credit balance should expire.                                                                                                                              |
+| `invoiceSettings`                                                                                                                                                                                                                | [IncrementCreditLedgerEntryInvoiceSettings](../../models/shared/incrementcreditledgerentryinvoicesettings.md)                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                               | Passing `invoice_settings` automatically generates an invoice for the newly added credits. If `invoice_settings` is passed, you must specify per_unit_cost_basis, as the calculation of the invoice total is done on that basis. |
+| `metadata`                                                                                                                                                                                                                       | [AddIncrementCreditLedgerEntryRequestParamsMetadata](../../models/shared/addincrementcreditledgerentryrequestparamsmetadata.md)                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                               | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                                    |
+| `perUnitCostBasis`                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                               | Can only be specified when entry_type=increment. How much, in USD, a customer paid for a single credit in this block                                                                                                             |

package/docs/models/shared/addincrementcreditledgerentryrequestparamsentrytype.md

@@ -0,0 +1,8 @@
+# AddIncrementCreditLedgerEntryRequestParamsEntryType
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `Increment` | increment   |

package/docs/models/shared/addincrementcreditledgerentryrequestparamsmetadata.md

@@ -0,0 +1,9 @@
+# AddIncrementCreditLedgerEntryRequestParamsMetadata
+
+User-specified key/value pairs for the ledger entry resource.
+
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/addpriceintervalparams.md

@@ -0,0 +1,16 @@
+# AddPriceIntervalParams
+
+
+## Fields
+
+| Field                                                                                                                   | Type                                                                                                                    | Required                                                                                                                | Description                                                                                                             | Example                                                                                                                 |
+| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `discounts`                                                                                                             | *any*[]                                                                                                                 | :heavy_minus_sign:                                                                                                      | A list of discounts to initialize on the price interval.                                                                |                                                                                                                         |
+| `endDate`                                                                                                               | *any*                                                                                                                   | :heavy_minus_sign:                                                                                                      | The end date of the price interval. This is the date that the price will stop billing on the subscription.              |                                                                                                                         |
+| `externalPriceId`                                                                                                       | *string*                                                                                                                | :heavy_minus_sign:                                                                                                      | The external price id of the price to add to the subscription.                                                          | external_price_id                                                                                                       |
+| `fixedFeeQuantityTransitions`                                                                                           | [PriceIntervalFixedFeeQuantityTransitionParams](../../models/shared/priceintervalfixedfeequantitytransitionparams.md)[] | :heavy_minus_sign:                                                                                                      | A list of fixed fee quantity transitions to initialize on the price interval.                                           |                                                                                                                         |
+| `maximumAmount`                                                                                                         | *number*                                                                                                                | :heavy_minus_sign:                                                                                                      | The maximum amount that will be billed for this price interval for a given billing period.                              | 1.23                                                                                                                    |
+| `minimumAmount`                                                                                                         | *number*                                                                                                                | :heavy_minus_sign:                                                                                                      | The minimum amount that will be billed for this price interval for a given billing period.                              | 1.23                                                                                                                    |
+| `price`                                                                                                                 | *any*                                                                                                                   | :heavy_minus_sign:                                                                                                      | The definition of a new price to create and add to the subscription.                                                    |                                                                                                                         |
+| `priceId`                                                                                                               | *string*                                                                                                                | :heavy_minus_sign:                                                                                                      | The id of the price to add to the subscription.                                                                         | h74gfhdjvn7ujokd                                                                                                        |
+| `startDate`                                                                                                             | *any*                                                                                                                   | :heavy_check_mark:                                                                                                      | The start date of the price interval. This is the date that the price will start billing on the subscription.           |                                                                                                                         |

package/docs/models/shared/addpriceintervalparamsenddateenddate.md

@@ -0,0 +1,11 @@
+# AddPriceIntervalParamsEndDateEndDate
+
+The end date of the price interval. This is the date that the price will stop billing on the subscription.
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `StartOfTerm` | start_of_term |
+| `EndOfTerm`   | end_of_term   |

package/docs/models/shared/addpriceintervalparamsstartdatestartdate.md

@@ -0,0 +1,11 @@
+# AddPriceIntervalParamsStartDateStartDate
+
+The start date of the price interval. This is the date that the price will start billing on the subscription.
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `StartOfTerm` | start_of_term |
+| `EndOfTerm`   | end_of_term   |

package/docs/models/shared/address.md

@@ -0,0 +1,13 @@
+# Address
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `city`             | *string*           | :heavy_check_mark: | N/A                |
+| `country`          | *string*           | :heavy_check_mark: | N/A                |
+| `line1`            | *string*           | :heavy_check_mark: | N/A                |
+| `line2`            | *string*           | :heavy_check_mark: | N/A                |
+| `postalCode`       | *string*           | :heavy_check_mark: | N/A                |
+| `state`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/shared/addressinput.md

@@ -0,0 +1,13 @@
+# AddressInput
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `city`             | *string*           | :heavy_minus_sign: | N/A                |
+| `country`          | *string*           | :heavy_minus_sign: | N/A                |
+| `line1`            | *string*           | :heavy_minus_sign: | N/A                |
+| `line2`            | *string*           | :heavy_minus_sign: | N/A                |
+| `postalCode`       | *string*           | :heavy_minus_sign: | N/A                |
+| `state`            | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/shared/addvoidcreditledgerentryrequestparams.md

@@ -0,0 +1,13 @@
+# AddVoidCreditLedgerEntryRequestParams
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.                                                                                                        |
+| `blockId`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                     | The ID of the block to void.                                                                                                                                                                                           |
+| `description`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc. |
+| `entryType`                                                                                                                                                                                                            | [AddVoidCreditLedgerEntryRequestParamsEntryType](../../models/shared/addvoidcreditledgerentryrequestparamsentrytype.md)                                                                                                | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |
+| `metadata`                                                                                                                                                                                                             | [AddVoidCreditLedgerEntryRequestParamsMetadata](../../models/shared/addvoidcreditledgerentryrequestparamsmetadata.md)                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                     | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                          |
+| `voidReason`                                                                                                                                                                                                           | [AddVoidCreditLedgerEntryRequestParamsVoidReason](../../models/shared/addvoidcreditledgerentryrequestparamsvoidreason.md)                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                     | Can only be specified when `entry_type=void`. The reason for the void.                                                                                                                                                 |