Invoices

Invoices are created automatically when a subscription is charged. An invoice captures the billing period of a subscription, including the subscription plan and line items prices. Payments are applied directly to an invoice.

The invoice model

Fields

id

objectId

Unique identifier for the invoice.

account_id

objectIdrequired

ID of the customer's account.

account

Account

Expandable link to the customer's account.

closed

boolean

When true, it indicates no further attempts will be made to capture payment for the invoice.

coupon

Coupon

Expandable link to the coupon applied to the invoice.

coupon_code

string

Coupon code applied to the invoice.

coupon_id

objectId

ID of the coupon applied to the invoice.

credits

Credit memo

Expandable list of account credit transactions. Balance of these transactions is kept in balance.

credit_total

currency

Total amount of additional credit applied to the order.

currency

string

Three-letter ISO currency code in uppercase. Defaults to the store's base currency.

currency_rate

float

Currency percentage used in calculating the fixed amount.

date_created

dateauto

Date and time the invoice was created.

date_due

date

The date by which the invoice is to be paid.

date_payment_retry

date

Date the next automatic payment will be attempted.

date_period_end

date

End date of the subscription billing period for the invoice.

date_period_start

date

Start date of the subscription billing period for the invoice.

date_updated

dateauto

Date and time the invoice was last updated.

discount_total

currencyauto

Total discount amount.

discounts

array of object

List of all discounts applied to the invoice.

grand_total

currencyauto

Grand total including items and taxes.

item_discount

currencyauto

Sum of all line items before discounts and taxes.

item_tax_included

boolean

Indicates line item prices include taxes.

item_tax

currencyauto

Total taxes applied to line items.

item_quantity

intauto

Total quantity of all line items.

item_quantity_creditable

int

Quantity of creditable items on the order.

items

array of object

List of invoice line items.

net_days

int

Net number of days for which the invoice is open before being considered past due.

notes

string

Internal admin notes, not visible to the customer.

number

stringauto

Unique incremental invoice number, assigned automatically.

order

Order

Expandable link to the order the invoice was applied to, if applicable.

order_id

objectId

ID of the order the invoice was applied to, if applicable.

paid

booleanauto

Indicates the invoice was paid in full.

pastdue

boolean

Indicates the invoice payment is past due.

payment_due

currencyauto

Payment amount due on the invoice.

payment_error

string

A message describing the last payment error, if one occurred.

payment_retry_count

int

The number of times automatic payment has been attempted.

payment_retry_resolve

string

The method used to resolve automatic payment when all retry attempts are exhausted. Can be blank (do nothing), canceled, or unpaid.

payment_total

currency

Sum of payments applied to the order, not including refunds.

payments

Paymentrequired

Expandable list of payments applied to the invoice.

refunds

Refund

Expandable list of refunds applied to the invoice.

shipment_tax

currency

Shipping tax amount, if applicable.

shipment_tax_included

boolean

Indicates shipping total includes taxes, if applicable.

shipment_tax_included_total

currency

Total of taxes applied separately from line items.

shipment_total

currency

Total shipping price after discounts.

source

Product

Expands into the corresponding order or subscription using source_model and source_id.

source_id

objectId

Used to expand source into corresponding order or subscription. Equal to order_id. If order_id is not set, then equal to subscription_id. If order_id nor subscription_id are set, is null.

source_model

string

Used to expand source into corresponding order or subscription. If order_id is set, equals orders. If subscription_id is set, equals subscriptions. When neither is set, is null.

status

enumauto

Current status of the invoice. Can be pending, paid, or unpaid.

Possible enum values:

pendingvoidpaidunpaid

sub_total

currencyauto

Sum of all line items before discounts, taxes and shipping.

subscription

Subscription

Expandable link to the subscription the invoice was issued for.

subscription_id

objectId

ID of the subscription the invoice was issued for.

tax_included_total

currencyauto

Total of taxes applied separately from line items.

tax_total

currencyauto

Total tax amount applied to the order including line items.

taxes

array of object

List of taxes applied to the order.

The invoice model

{
  "id": "60f199509111e7000000002f",
  "account_id": "60f199509111e70000000031",
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.194Z",
  "date_updated": "2021-07-16T14:36:00.194Z",
  "items": [
    {
      "id": "5ca537326a0ec32a521139dd",
      "product_id": "5c524166f4e8f3446a10331b",
      "variant_id": "5c524166f4e8f3446a10331f",
      "quantity": 2,
      "price": 19.99,
      "price_total": 38.98,
      "orig_price": 19.99,
      "options": [
        {
          "id": "5becb84fac207653a4816ee5",
          "name": "Type",
          "value": "Elven"
        },
        {
          "id": "5becb84fac207653a4816ee6",
          "name": "Enchanted",
          "value": "Fire"
        }
      ],
      "discounts": [
        {
          "id": "coupon-0",
          "amount": 5
        }
      ],
      "discount_each": 2.5,
      "discount_total": 5,
      "taxes": [
        {
          "id": "sales-tax",
          "amount": 2
        }
      ],
      "tax_each": 1,
      "tax_total": 2
    }
  ],
  "number": 117266,
  "paid": false,
  "pastdue": false,
  "status": "pending"
}

Retrieve an invoice

Retrieve an existing invoice using the ID that was returned when created.

Arguments

id

objectIdrequired

ID of the invoice to retrieve.

expand

string

Expanding link fields and child collections is performed using the expand argument.

For example, expand=account would return a related customer account if one exists.

When the field represents a collection, you can specify the query limit.

For example, expand=variants:10 would return up to 10 records of the variants collection.

See expanding for more details.

fields

string

Return only the specified fields in the result. For example fields=name,slug would return only the fields name and slug in the response. Supports nested object and array fields using dot-notation. For example, items.product_id. The gift card id is always returned.

include

string

Include one or more arbitrary queries in the response, possibly related to the main query.

See including for more details.

GET/invoices/:id

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.get('/invoices/{id}', {
  id: '60f199509111e70000000033'
});

Response

{
  "id": "60f199509111e70000000037",
  "account_id": "60f199509111e70000000038",
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.194Z",
  "date_updated": "2021-07-16T14:36:00.194Z",
  "items": [
    {
      "id": "5ca537326a0ec32a521139dd",
      "product_id": "5c524166f4e8f3446a10331b",
      "variant_id": "5c524166f4e8f3446a10331f",
      "quantity": 2,
      "price": 19.99,
      "price_total": 38.98,
      "orig_price": 19.99,
      "options": [
        {
          "id": "5becb84fac207653a4816ee5",
          "name": "Size",
          "value": "Small"
        },
        {
          "id": "5becb84fac207653a4816ee6",
          "name": "Color",
          "value": "Yellow"
        }
      ],
      "discounts": [
        {
          "id": "coupon-0",
          "amount": 5
        }
      ],
      "discount_each": 2.5,
      "discount_total": 5,
      "taxes": [
        {
          "id": "sales-tax",
          "amount": 2
        }
      ],
      "tax_each": 1,
      "tax_total": 2
    }
  ],
  "number": 117266,
  "paid": false,
  "pastdue": false,
  "status": "pending"
}

List all invoices

Return a list of invoices.

Arguments

expand

string

Expand link fields and child collections by using the expand argument.

For example, expand=account would return a related customer account if one exists.

When the field represents a collection, you can specify the query limit.

For example, expand=variants:10 would return up to 10 records of the variants collection.

See expanding for more details.

fields

string

Returns only the specified fields in the result.

For example fields=name,slug would return only the fields name and slug in the response.

Supports nested object and array fields using dot-notation.

For example, items.product_id. The product id is always returned.

include

object

Include one or more arbitrary queries in the response which are potentially related to the main query.

See including for more details.

limit

int

Limit the number of records returned, ranging between 1 and 1000. Defaults to 15.

page

int

The page number of results to return given the specified or default limit.

search

string

A text search is performed using the search argument. Searchable fields are defined by the model.

For example, search=red would return records containing the word "red" anywhere in the defined text fields.

See searching for more details.

sort

string

Expression to sort results by using a format similar to a SQL sort statement.

For example, sort=name asc would return records sorted by name ascending.

See sorting for more details.

where

object

An object with criteria to filter the result.

For example, active=true would return records containing a field active with the value true.

It's also possible to use query operators, for example, $eq, $ne, $gt, and more.

See querying for more details.

GET/invoices

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.get('/invoices/{id}', {
  id: '60f199509111e70000000033'
});

Response

{
  "count": 51,
  "results": [
    {
      "id": "60f199509111e7000000002f",
      "account_id": "60f199509111e7000000003c",
      "currency": "USD",
      "date_created": "2021-07-16T14:36:00.194Z",
      "date_updated": "2021-07-16T14:36:00.194Z",
      "items": [
        {
          "id": "5ca537326a0ec32a521139dd",
          "product_id": "5c524166f4e8f3446a10331b",
          "variant_id": "5c524166f4e8f3446a10331f",
          "quantity": 2,
          "price": 19.99,
          "price_total": 38.98,
          "orig_price": 19.99,
          "options": [
            {
              "id": "5becb84fac207653a4816ee5",
              "name": "Size",
              "value": "Small"
            },
            {
              "id": "5becb84fac207653a4816ee6",
              "name": "Color",
              "value": "Yellow"
            }
          ],
          "discounts": [
            {
              "id": "coupon-0",
              "amount": 5
            }
          ],
          "discount_each": 2.5,
          "discount_total": 5,
          "taxes": [
            {
              "id": "sales-tax",
              "amount": 2
            }
          ],
          "tax_each": 1,
          "tax_total": 2
        }
      ],
      "number": 117266,
      "paid": false,
      "pastdue": false,
      "status": "pending"
    },
    {...},
    {...}
  ],
  "page": 1,
  "pages": {
    "1": {
      "start": 1,
      "end": 25
    },
    "2": {
      "start": 26,
      "end": 50
    },
    "2": {
      "start": 51,
      "end": 51
    }
  }
}

← Back: Account credits Next: Coupons →

Invoices

The invoice model

Fields

id

account_id

account

closed

coupon

coupon_code

coupon_id

credits

credit_total

currency

currency_rate

date_created

date_due

date_payment_retry

date_period_end

date_period_start

date_updated

discount_total

discounts

id

amount

rule

type

grand_total

item_discount

item_tax_included

item_tax

item_quantity

item_quantity_creditable

items

id

bundle_items

.id

.product_id

.product

.quantity

.quantity_total

.variant_id

.variant

description

discount_each

discount_total

discounts

id

amount

options

id

name

value

price

price_total

product_id

product

quantity

taxes

.id

.amount

tax_each

tax_total

variant_id

variant

quantity_creditable

quantity_credited

net_days

notes

number

order

order_id

paid

pastdue

payment_due

payment_error

payment_retry_count

payment_retry_resolve

payment_total

payments

refunds