WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Invoices
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
    • Retrieve a refund
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • 订阅计划升降级与按比例分摊
      • subscription
        • 创建订阅
        • confirm
        • 更新item
        • 支付invoice
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
    • Expire a Session Copy
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
      POST
    • Retrieve an invoice
      GET
    • Finalize an invoice
      POST
    • Send an invoice for manual payment
      POST
    • Delete a draft invoice
      GET
    • Void an invoice
      POST
    • List all invoices
      GET
    • Pay an invoice
      POST
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Invoices

Delete a draft invoice

Developing
GET
/v1/invoices/{id}

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

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://apitest.wooshpay.com/v1/invoices/' \
--header 'Accept;' \
--header 'Authorization: Basic Og=='

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"
}
Modified at 2023-11-01 08:35:06
Previous
Send an invoice for manual payment
Next
Void an invoice
Built with