Skip to content
This repository was archived by the owner on Oct 17, 2023. It is now read-only.

Latest commit

 

History

History
23 lines (19 loc) · 2.75 KB

File metadata and controls

23 lines (19 loc) · 2.75 KB

CreditNote

Properties

Name Type Description Notes
created datetime { "description" : "The UTC DateTime when the object was created.", "verbs":[] } [optional]
changed_by str { "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 str { "description" : "", "verbs":["GET"] } [optional]
account_id str { "description" : "", "verbs":["POST","GET"] }
invoice_id str { "description" : "References an invoice from this credit note. This has no side-effects, such as limited scope of credit note.", "verbs":["POST","GET"] } [optional]
subscription_id str { "description" : "Subscription to apply the credit note to. By default credit notes are owned by the account an can be used on any subscription. Providing this value limits the credit-note to only being used on the specified subscription.", "verbs":["POST","GET"] } [optional]
organization_id str { "description" : "", "verbs":[] } [optional]
type str { "description" : "", "verbs":[] }
currency str { "description" : "Currency of the credit-note specified by a three character ISO 4217 currency code.", "verbs":["POST","GET"] }
description str { "description" : "", "verbs":["POST","GET"] } [optional]
value float { "description" : " Monetary value of the credit-note", "verbs":["POST","GET"] }
remaining_value float { "description" : "Remaining value of the payment not used. In the case when a credit-note is used across a range of invoices, each use reducing the available blance of the credit note.", "verbs":["GET"] }
created_by str { "description" : "", "verbs":["GET"] } [optional]

[Back to Model list] [Back to API list] [Back to README]