| Name | Type | Description | Notes |
|---|---|---|---|
| created | DateTime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| id | String | {"description":"ID of an existing charge to add to the invoice ","verbs":["POST","GET"]} | [optional] |
| name | String | {"description":"Friendly name given to the charge to help identify it.","verbs":["POST","GET"]} | [optional] |
| description | String | {"description":"","verbs":["POST","GET"]} | [optional] |
| currency | String | { "description" : "Currency of the invoice specified by a three character ISO 4217 currency code.", "verbs":["GET"] } | [optional] |
| amount | Float | {"description":"Monetary amount for which to charge. Used only for ad-hoc charges i.e charges not associated with any pricing component. Applicable if pricingComponent is NOT defined","verbs":["POST","GET"]} | [optional] |
| tax_amount | BOOLEAN | {"default":false,"description":"Applicable if amount is specified and indicates whether or not to apply tax in addition to the value specified.<br><span class=\"label label-default\">true</span> — Tax will be added on top of the nominal price specified in amount — in accordance with any taxation strategies you have defined.<br><span class=\"label label-default\">false</span> — No tax will be applied on top of the price specified in amount.","verbs":["POST","GET"]} | [optional] [default to false] |
| period_start | DateTime | {"default":"Now","description":"Start of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods. Pro-rating the price of pricingComponents purchased","verbs":["POST","GET"]} | [optional] |
| period_end | DateTime | {"default":"(End of current period)","description":"(Applicable only if `pricingComponent` is defined)<br>End of the interval to which the charge applies. Used in pro-rata calculation","verbs":["POST","GET"]} | [optional] |
| invoicing_type | String | {"default":"<span class=\"label label-default\">Aggregated</span>","description":"Applicable if adding a charge to the subscription.<br><span class=\"label label-default\">Immediate</span> — Generate straight-away an invoice containing these charges.<br><span class=\"label label-default\">Aggregated</span> — Add these charges to the next invoice — for example the invoice raised at the current period's end.","verbs":["POST","GET"]} | [optional] |
| charge_type | String | {"default":"<span class=\"label label-default\">Debit</span>","description":"Whether this charge represents an increase or decrease in invoice cost<br><span class=\"label label-default\">Credit</span> — This results in a reduction to the invoice cost<br><span class=\"label label-default\">Debit</span> — This will increase the invoice cost","verbs":["POST","GET"]} | [optional] |
| trial | BOOLEAN | {"default":"false","description":"Whether the charge is meant in the context of a trial.<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] |
| 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"]} | |
| pricing_component | String | {"description":"Specifies that this charge is for consumption of some quantity of this pricing component (whose name or ID can be provided).<br>If left blank:<br>The charge will be created as 'ad-hoc'. That is: a monetary lump sum, associated with no pricing component","verbs":["POST","GET"]} | [optional] |
| pricing_component_value | Integer | {"description":"The value consumed of the pricing component which this charge concerns.Required if pricingComponent is defined","verbs":["POST","GET"]} | [optional] |
| dry_run | BOOLEAN | {"default":false,"description":"Changes described in the response:<br><span class=\"label label-default\">true</span> — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\"label label-default\">false</span> — Are actually performed and committed.","verbs":["POST","GET"]} | [optional] [default to false] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.