Finalize an invoice - WooshPay OpenAPI

Wooshpay automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

Returns an invoice object with status=open.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Header Params

Body Params application/json

Example

{
    "auto_advance": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

Example

{
    "id": "string",
    "currency": "string",
    "customer": "string",
    "object": "string",
    "auto_advance": true,
    "charge": "string",
    "collection_method": "string",
    "description": "string",
    "hosted_invoice_url": "string",
    "lines": {
        "object": "string",
        "data": [
            {
                "id": "string",
                "object": "string",
                "amount": 0,
                "currency": "string",
                "description": "string",
                "metadata": {},
                "period": {
                    "end": "string",
                    "start": "string"
                },
                "price": {
                    "id": "string",
                    "object": "string",
                    "active": true,
                    "billing_scheme": "per_unit",
                    "created": 0,
                    "currency": "string",
                    "livemode": true,
                    "lookup_key": "string",
                    "metadata": {},
                    "nickname": "string",
                    "product": "string",
                    "type": "one_time",
                    "unit_amount": 0,
                    "recurring": {
                        "interval": "day",
                        "interval_count": 0,
                        "usage_type": "licensed"
                    },
                    "tiers": [
                        {
                            "up_to": "string",
                            "flat_amount": "string",
                            "unit_amount": "string"
                        }
                    ]
                },
                "unit_amount": "string",
                "quantity": 0,
                "invoice_item": "string",
                "type": "string",
                "livemode": true,
                "subscription": "string",
                "subscription_item": "string",
                "unit_amount_excluding_tax": 0,
                "discount_amounts": [
                    {
                        "amount": "string",
                        "discount": "string"
                    }
                ],
                "discountable": true
            }
        ],
        "has_more": true,
        "url": "string"
    },
    "metadata": {},
    "payment_intent": "string",
    "period_end": "string",
    "period_start": "string",
    "status": "string",
    "subscription": "string",
    "account_country": "string",
    "account_name": "string",
    "amount_due": 0,
    "amount_paid": 0,
    "amount_precision": 0,
    "billing_reason": "manual",
    "created": 0,
    "custom_fields": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "customer_address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string"
    },
    "customer_email": "string",
    "customer_name": "string",
    "customer_phone": "string",
    "customer_shipping": {
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
        },
        "name": "string",
        "phone": "string"
    },
    "default_payment_method": "string",
    "due_date": "string",
    "effective_at": "string",
    "footer": "string",
    "from_invoice": {
        "action": "string",
        "invoice": "string"
    },
    "invoice_pdf": "string",
    "last_finalization_error": {
        "type": "string",
        "code": "string",
        "message": "string",
        "param": "string",
        "payment_method_type": "string"
    },
    "latest_revision": "string",
    "livemode": true,
    "next_payment_attempt": "string",
    "number": "string",
    "paid": true,
    "paid_out_of_band": true,
    "payment_settings": {
        "default_mandate": "string",
        "payment_method_options": {
            "card": {
                "request_three_d_secure": "string"
            }
        },
        "payment_method_types": "string"
    },
    "receipt_number": "string",
    "starting_balance": "string",
    "statement_descriptor": "string",
    "status_transitions": {
        "finalized_at": "string",
        "marked_uncollectible_at": "string",
        "paid_at": "string",
        "voided_at": "string"
    },
    "subscription_details": {
        "metadata": {}
    },
    "test_clock": "string",
    "threshold_reason": {
        "amount_gte": "string",
        "item_reasons": [
            {
                "line_item_ids": "string",
                "usage_gte": "string"
            }
        ]
    },
    "total": 0,
    "rounding_rule": "round_up"
}