InvoiceLinePayment.md

InvoiceLinePayment

Properties

Name	Type	Description	Notes
period_start	datetime	{"description":"PeriodStart of the charge with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
period_end	datetime	{"description":"PeriodEnd of the charge with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
payment_received	datetime	{"description":"The date when the associated payment was received.","verbs":["POST","PUT","GET"]}
refund_received	datetime	{"description":"The date when the associated payment was refunded.","verbs":["POST","PUT","GET"]}
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]
id	str	{"description":"ID of the InvoiceLinePayment.","verbs":["POST","PUT","GET"]}	[optional]
organization_id	str	{"description":"ID of the organization associated with the InvoiceLinePayment.","verbs":["POST","PUT","GET"]}
payment_id	str	{"description":"ID of the Payment used upon this InvoiceLinePayment's invoice line.","verbs":["POST","PUT","GET"]}
gateway_original_payment_reference	str	{"description":"Reference with which the original payment transaction can be looked up in its gateway.","verbs":["POST","PUT","GET"]}
gateway_refund_payment_reference	str	{"description":"Reference with which the refund transaction for the payment can be looked up in its gateway.","verbs":["POST","PUT","GET"]}
aggregated_invoice_id	str	{"description":"ID of the invoice to which this InvoiceLinePayment's invoice line belongs.","verbs":["POST","PUT","GET"]}
aggregated_invoice_line_id	str	{"description":"ID of the invoice line toward which this InvoiceLinePayment contributes payment.","verbs":["POST","PUT","GET"]}
invoice_payment_id	str	{"description":"ID of the InvoicePayment with which this InvoiceLinePayment is associated.","verbs":["POST","PUT","GET"]}
currency	str	{"description":"The currency of the payment — specified by a three-character ISO 4217 currency code.","verbs":["POST","PUT","GET"]}
gateway	str	{"description":"Payment gateway through which the payment was made.","verbs":["POST","PUT","GET"]}
nominal_amount	float	{"description":"The amount paid — through credit or otherwise — toward this invoice line.","verbs":["POST","PUT","GET"]}
actual_amount	float	{"description":"The amount paid — through real money — toward this invoice line.","verbs":["POST","PUT","GET"]}
refunded_amount	float	{"description":"The monetary amount refunded toward this invoice line.","verbs":["POST","PUT","GET"]}
pricing_component_id	str	{"description":"ID of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
pricing_component_name	str	{"description":"Name of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_rate_plan_id	str	{"description":"ID of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_rate_plan_name	str	{"description":"Internal name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_rate_plan_name_public	str	{"description":"Public name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_id	str	{"description":"ID of the Product with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_name	str	{"description":"Internal name of the Product with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_name_public	str	{"description":"Public name of the Product with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
subscription_id	str	{"description":"ID of the Subscription with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}
account_id	str	{"description":"ID of the Account with which this InvoiceLinePayment's invoice line is associated.","verbs":["POST","PUT","GET"]}

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