Backend API

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.

Fields

idobjectId

Unique identifier for the invoice.

account_idobjectIdrequired

ID of the customer's account.

accountAccount

Expandable link to the customer's account.

closedboolean

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

couponCoupon

Expandable link to the coupon applied to the invoice.

coupon_codestring

Coupon code applied to the invoice.

coupon_idobjectId

ID of the coupon applied to the invoice.

creditsCredit Memo

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

credit_totalcurrency

Total amount of additional credit applied to the order.

currencystring

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

currency_ratefloat

Currency percentage used in calculating the fixed amount.

date_createddateauto

Date and time the invoice was created.

date_duedate

The date by which the invoice is to be paid.

date_payment_retrydate

Date the next automatic payment will be attempted.

date_period_enddate

End date of the subscription billing period for the invoice.

date_period_startdate

Start date of the subscription billing period for the invoice.

date_updateddateauto

Date and time the invoice was last updated.

discount_totalcurrencyauto

Total discount amount.

discountsarray of object

List of all discounts applied to the invoice.

grand_totalcurrencyauto

Grand total including items and taxes.

item_discountcurrencyauto

Sum of all line items before discounts and taxes.

item_tax_includedboolean

Indicates line item prices include taxes.

item_quantityintauto

Total quantity of all line items.

item_quantity_creditableint

Quantity of creditable items on the order.

item_taxcurrencyauto

Total taxes applied to line items.

itemsarray of object

List of invoice line items.

notesstring

Internal admin notes, not visible to the customer.

numberstringauto

Unique incremental invoice number, assigned automatically.

orderOrder

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

order_idobjectId

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

paidbooleanauto

Indicates the invoice was paid in full.

pastdueboolean

Indicates the invoice payment is past due.

payment_duecurrencyauto

Payment amount due on the invoice.

payment_errorstring

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

payment_retry_countint

The number of times automatic payment has been attempted.

payment_retry_resolvestring

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

payment_totalcurrency

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

paymentsPaymentrequired

Expandable list of payments applied to the invoice.

refundsRefund

Expandable list of refunds applied to the invoice.

shipment_taxcurrency

Shipping tax amount, if applicable.

shipment_tax_includedboolean

Indicates shipping total includes taxes, if applicable.

shipment_tax_included_totalcurrency

Total of taxes applied separately from line items.

shipment_totalcurrency

Total shipping price after discounts.

sourceProduct

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

source_idobjectId

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_modelstring

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.

statusenumauto

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

sub_totalcurrencyauto

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

subscriptionSubscription

Expandable link to the subscription the invoice was issued for.

subscription_idobjectId

ID of the subscription the invoice was issued for.

tax_included_totalcurrencyauto

Total of taxes applied separately from line items.

tax_totalcurrencyauto

Total tax amount applied to the order including line items.

taxesarray 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 existing invoice using the ID that was returned when created.

Arguments

idobjectIdrequired

ID of the invoice to retrieve.

expandstring

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.

fieldsstring

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.

includestring

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"
}

Return a list of invoices.

Arguments

expandstring

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.

fieldsstring

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.
includeobject

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

See including for more details.

limitint

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

pageint

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

searchstring

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.

sortstring

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.

whereobject

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
    }
  }
}