Update Customer Information
Updates customer information on an open invoice and returns the updated invoice. If you would like to preview changes that will be applied, use the /invoices/{uid}/customer_information/preview.json endpoint first.
The endpoint doesn't accept a request body. Customer information differences are calculated on the application side.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The unique identifier for the invoice, this does not refer to the public facing invoice number.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/invoices/string/customer_information.json"{ "uid": "elit Ut", "site_id": 46283786, "customer_id": -62349460, "subscription_id": 12801726, "number": "dolore et ut", "sequence_number": -84210096, "issue_date": "2017-01-01", "due_date": "2017-01-30", "paid_date": "2017-01-28", "status": "open", "collection_method": "automatic", "payment_instructions": "enim officia", "currency": "dolore", "consolidation_level": "none", "product_name": "occaecat veniam culpa", "product_family_name": "qui commodo ea dolore cillum", "seller": { "name": "co", "phone": "ullamco in officia" }, "customer": { "chargify_id": -55826334, "first_name": "deserunt", "last_name": "velit dolore", "email": "aliquip sed velit Lorem" }, "memo": "ea cupidatat deserunt", "billing_address": { "street": "qui commodo cupidatat sunt", "line2": "ut officia enim", "city": "velit minim dolore sint nulla", "state": "velit", "zip": "ullamco", "country": "irure est laborum deserun" }, "shipping_address": { "street": "do fugiat dolore deserunt officia", "line2": "ipsum cillum", "city": "aliqua laboris incididunt ut", "state": "et fugiat sit", "zip": "dolore do", "country": "Excepteur consequat cillum" }, "subtotal_amount": "dolore mollit", "discount_amount": "aute", "tax_amount": "eu aliqua est velit ea", "total_amount": "ut non", "credit_amount": "sit", "refund_amount": "et eiusmod qui sed", "paid_amount": "amet nulla s", "due_amount": "non esse ullamco", "line_items": [ { "description": "qui", "price_point_id": 123, "tax_amount": "occaecat deserunt veniam", "subtotal_amount": "commodo consequat tempor et Duis" }, { "uid": "", "subtotal_amount": "ven" }, { "price_point_id": 94750853, "product_id": 79058036, "tax_amount": "1.0", "subtotal_amount": "128.5" }, { "unit_price": "eiusmod consequat ut nostrud", "tax_amount": "quis nulla proident" }, { "period_range_end": "2022-02-02", "product_id": 57352537, "description": "minim in dolore Ut Excepteur", "uid": "sit qui in ullamco anim" } ], "discounts": [ { "title": "nostrud" } ], "taxes": [ { "source_type": "Tax", "line_item_breakouts": [ { "uid": "in ipsum", "tax_amount": "velit", "taxable_amount": "quis sint" }, { "uid": "co" } ] }, { "uid": "enim irure in", "title": "incididunt est mollit irure" } ], "credits": [ { "uid": "exercitation eiusmod", "transaction_time": "2024-01-23T13:51:27Z", "credit_note_number": "qui fugiat labore laborum", "credit_note_uid": "ipsum sunt" }, { "memo": "dolor" } ], "refunds": [ { "memo": "deserunt elit" }, { "original_amount": "Duis nulla" } ], "payments": [ { "prepayment": false, "memo": "enim Excepteur Lorem magna sit" }, { "transaction_time": "2024-01-23T13:51:27Z", "prepayment": false, "payment_method": { "details": "labore ut et", "kind": "dolor qui", "memo": "ea commodo", "type": "fugiat veniam", "card_brand": "consequat", "card_expiration": "aliqua a", "last_four": "ut in consectetur sed", "masked_card_number": "minim ea ullamco nostrud tempor" } }, { "prepayment": true, "transaction_id": 67527234 }, { "original_amount": "c", "memo": "dolore fugiat labore" } ], "custom_fields": [ { "name": "CustomerStatus", "value": "Gold", "owner_type": "Customer", "owner_id": 18482224, "metadatum_id": 13924 }, { "name": "SubscriptionTag", "value": "Special Subscriber", "owner_type": "Subscription", "owner_id": 21344, "metadatum_id": 139245 } ], "public_url": "dolo", "previous_balance_data": { "captured_at": "2024-01-09T11:22:23-05:00", "invoices": [ { "number": "veniam dolore labore ipsum cupidatat", "uid": "tempor", "outstanding_amount": "Excepteur nostrud irur" }, { "outstanding_amount": "id" } ] }, "public_url_expires_on": "2024-11-21"}Preview Customer Information Changes POST
Previews the effect of customer information changes on an open invoice. Customer information may change after an invoice is issued, which may lead to a mismatch between customer information that is present on an open invoice and actual customer information. This endpoint allows you to preview these differences, if any. The endpoint doesn't accept a request body. Customer information differences are calculated on the application side.
Issue Invoice POST
Issues an invoice that is in "pending" or "draft" status. For example, you can issue an invoice that was created when allocating new quantity on a component and using "accrue charges" option. You cannot issue a pending child invoice that was created for a member subscription in a group. For Remittance subscriptions, the invoice will go into "open" status and payment won't be attempted. The value for `on_failed_payment` would be rejected if sent. Any prepayments or service credits that exist on the subscription will be automatically applied. Additionally, if the setting is enabled, an email will be sent for the issued invoice. For Automatic subscriptions, prepayments and service credits will apply to the invoice before payment is attempted. On successful payment, the invoice will go into "paid" status and email will be sent to the customer (if setting applies). When payment fails, the next event depends on the `on_failed_payment` value: - `leave_open_invoice` - prepayments and credits applied to invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history. This is the default option. - `rollback_to_pending` - prepayments and credits not applied; invoice remains in "pending" status; no email sent to the customer; payment failure recorded in the invoice history. - `initiate_dunning` - prepayments and credits applied to the invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history; subscription will most likely go into "past_due" or "canceled" state (depending upon net terms and dunning settings).