| Name | Type | Description | Notes |
|---|---|---|---|
| created | DateTime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| changed_by | String | { "description" : "ID of the user who last updated the entity.", "verbs":[] } | [optional] |
| updated | DateTime | { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] } | [optional] |
| id | String | {"description":"The ID of the charge.","verbs":["GET"]} | [optional] |
| crm_id | String | {"description":"Customer-relationship-management ID of the charge.","verbs":["GET","PUT","POST"]} | [optional] |
| account_id | String | {"description":"ID of the account owning the subscription for which the charge was generated.","verbs":["GET","POST"]} | [optional] |
| subscription_id | String | {"description":"ID of the subscription for which the charge was generated.","verbs":["GET","POST"]} | [optional] |
| subscription_version_id | String | {"description":"Version ID of the subscription for which the charge was generated.","verbs":["GET","POST"]} | [optional] |
| invoice_id | String | {"description":"ID of the invoice to which this charge applies (if the charge targets a specific invoice).","verbs":["POST","GET"]} | [optional] |
| name | String | {"description":"Friendly name given to the charge to help identify it.","verbs":["POST","GET","PUT"]} | [optional] |
| description | String | {"description":"Description given to the charge.","verbs":["POST","GET","PUT"]} | [optional] |
| amount | Float | {"description":"Monetary amount of the charge — including any tax applied to the final amount.","verbs":["POST","GET"]} | [optional] |
| amount_excluding_tax | Float | {"description":"Monetary amount of the charge — excluding any tax applied to the final amount.","verbs":["GET"]} | [optional] |
| currency | String | { "description" : "Currency of the invoice specified by a three character ISO 4217 currency code.", "verbs":["GET"] } | [optional] |
| period_start | DateTime | {"default":"(Now)","description":"The time-beginning of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.","verbs":["POST","GET"]} | [optional] |
| period_end | DateTime | {"default":"(End of current period)","description":"The time-ending of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.","verbs":["POST","GET"]} | [optional] |
| type | String | {"description":"A type describing the nature of the charge.","verbs":["POST","GET"]} | |
| invoicing_type | String | {"default":"<span class=\"label label-default\">Aggregated</span>","description":"The strategy for how this charge will raise invoices.<br><span class=\"label label-default\">Immediate</span> — Generate straight-away an invoice containing this charge.<br><span class=\"label label-default\">Aggregated</span> — Add this charge to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.","verbs":["POST","GET"]} | |
| state | String | {"default":"<span class=\"label label-default\">Pending</span>","description":"The current state of the charge.","verbs":["POST","GET","PUT"]} | |
| charge_type | String | {"default":"<span class=\"label label-default\">Debit</span>","description":"Whether this charge represents money given to or taken from the customer.<br><span class=\"label label-default\">Credit</span> — This is a charge for money given to the customer.<br><span class=\"label label-default\">Debit</span> — This is a charge for money taken from the customer.","verbs":["POST","GET"]} | |
| calculation | String | {"default":"(Empty string)","description":"A human-readable explanation of how the value of the charge was calculated.","verbs":["GET"]} | [optional] |
| remaining_credit_behaviour | String | {"default":"<span class=\"label label-default\">Rollover</span>","description":"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..<br><span class=\"label label-default\">Rollover</span> — Outstanding credit is returned to the accounts credit pool.<br><span class=\"label label-default\">Discard</span> — Outstanding credit is lost.","verbs":["POST","GET"]} | |
| trial | BOOLEAN | {"default":"false","description":"(Applicable only if any of [`pricingComponentName`, `pricingComponentID`] are defined)<br>Whether the charge was created for a subscription whilst in a trial period.<br><span class=\"label label-default\">false</span> — This is a non-trial charge, so funds will be sought from the customer.<br><span class=\"label label-default\">true</span> — This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.","verbs":["POST","GET"]} | [optional] [default to false] |
| version_id | String | {"description":"The version ID of the charge.","verbs":["GET"]} | [optional] |
| version_number | Integer | {"description":"The version number of the charge. The first version of a charge is version number 1.","verbs":["GET"]} |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.