Invoice

Void invoice

This endpoint allows an invoice’s status to be set the void status. This can only be done to invoices that are in the issued status.

If the associated invoice has used the customer balance to change the amount due, the customer balance operation will be reverted. For example, if the invoice used $10 of customer balance, that amount will be added back to the customer balance upon voiding.

If the invoice was used to purchase a credit block, but the invoice is not yet paid, the credit block will be voided. If the invoice was created due to a top-up, the top-up will be disabled.

POST

invoices

{invoice_id}

void

curl --request POST \
  --url https://api.withorb.com/v1/invoices/{invoice_id}/void \
  --header 'Authorization: Bearer <token>'

{
  "metadata": {},
  "voided_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "scheduled_issue_at": "2023-11-07T05:31:56Z",
  "auto_collection": {
    "next_attempt_at": "2023-11-07T05:31:56Z",
    "previously_attempted_at": "2023-11-07T05:31:56Z",
    "enabled": true,
    "num_attempts": 123
  },
  "issue_failed_at": "2023-11-07T05:31:56Z",
  "sync_failed_at": "2023-11-07T05:31:56Z",
  "payment_failed_at": "2023-11-07T05:31:56Z",
  "payment_started_at": "2023-11-07T05:31:56Z",
  "amount_due": "8.00",
  "created_at": "2022-05-01T07:01:31+00:00",
  "currency": "USD",
  "customer": {
    "id": "<string>",
    "external_customer_id": "<string>"
  },
  "discount": "<any>",
  "discounts": [
    {
      "discount_type": "percentage",
      "applies_to_price_ids": [
        "h74gfhdjvn7ujokd",
        "7hfgtgjnbvc3ujkl"
      ],
      "reason": "<string>",
      "percentage_discount": 0.15
    }
  ],
  "due_date": "2022-05-30T07:00:00+00:00",
  "id": "<string>",
  "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
  "invoice_number": "JYEFHK-00001",
  "minimum": {
    "minimum_amount": "<string>",
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "minimum_amount": "<string>",
  "maximum": {
    "maximum_amount": "<string>",
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "maximum_amount": "<string>",
  "line_items": [
    {
      "amount": "7.00",
      "discount": {
        "discount_type": "percentage",
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "reason": "<string>",
        "percentage_discount": 0.15
      },
      "end_date": "2022-02-01T08:00:00+00:00",
      "grouping": "<string>",
      "minimum": {
        "minimum_amount": "<string>",
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "minimum_amount": "<string>",
      "maximum": {
        "maximum_amount": "<string>",
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "maximum_amount": "<string>",
      "adjustments": [
        {
          "id": "<string>",
          "is_invoice_level": true,
          "applies_to_price_ids": [
            "<string>"
          ],
          "reason": "<string>",
          "adjustment_type": "usage_discount",
          "usage_discount": 123,
          "amount": "<string>"
        }
      ],
      "name": "Fixed Fee",
      "quantity": 1,
      "start_date": "2022-02-01T08:00:00+00:00",
      "subtotal": "9.00",
      "adjusted_subtotal": "5.00",
      "credits_applied": "6.00",
      "partially_invoiced_amount": "4.00",
      "sub_line_items": [
        {
          "amount": "9.00",
          "name": "Tier One",
          "quantity": 5,
          "grouping": {
            "key": "region",
            "value": "west"
          },
          "type": "matrix",
          "matrix_config": {
            "dimension_values": [
              "<string>"
            ]
          }
        }
      ],
      "tax_amounts": [
        {
          "tax_rate_description": "<string>",
          "tax_rate_percentage": "<string>",
          "amount": "<string>"
        }
      ],
      "id": "<string>",
      "price": {
        "metadata": {},
        "id": "<string>",
        "name": "<string>",
        "external_price_id": "<string>",
        "price_type": "usage_price",
        "model_type": "unit",
        "created_at": "2023-11-07T05:31:56Z",
        "cadence": "one_time",
        "billing_cycle_configuration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "invoicing_cycle_configuration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "billable_metric": {
          "id": "<string>"
        },
        "dimensional_price_configuration": {
          "dimensional_price_group_id": "<string>",
          "dimension_values": [
            "<string>"
          ]
        },
        "fixed_price_quantity": 123,
        "plan_phase_order": 123,
        "currency": "<string>",
        "conversion_rate": 123,
        "item": {
          "id": "<string>",
          "name": "<string>"
        },
        "credit_allocation": {
          "currency": "<string>",
          "allows_rollover": true
        },
        "discount": {
          "discount_type": "percentage",
          "applies_to_price_ids": [
            "h74gfhdjvn7ujokd",
            "7hfgtgjnbvc3ujkl"
          ],
          "reason": "<string>",
          "percentage_discount": 0.15
        },
        "minimum": {
          "minimum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "minimum_amount": "<string>",
        "maximum": {
          "maximum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "unit_config": {
          "unit_amount": "<string>"
        }
      },
      "usage_customer_ids": [
        "<string>"
      ],
      "filter": "<string>"
    }
  ],
  "subscription": {
    "id": "VDGsT23osdLb84KD"
  },
  "subtotal": "8.00",
  "total": "8.00",
  "customer_balance_transactions": [
    {
      "id": "cgZa3SXcsPTVyC4Y",
      "created_at": "2022-05-01T07:01:31+00:00",
      "starting_balance": "33.00",
      "ending_balance": "22.00",
      "amount": "11.00",
      "action": "applied_to_invoice",
      "description": "An optional description",
      "invoice": {
        "id": "gXcsPTVyC4YZa3Sc"
      },
      "type": "increment",
      "credit_note": {
        "id": "<string>"
      }
    }
  ],
  "status": "issued",
  "invoice_source": "subscription",
  "shipping_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "hosted_invoice_url": "<string>",
  "will_auto_issue": true,
  "eligible_to_issue_at": "2023-11-07T05:31:56Z",
  "customer_tax_id": {
    "country": "AD",
    "type": "ad_nrt",
    "value": "<string>"
  },
  "memo": "<string>",
  "credit_notes": [
    {
      "id": "<string>",
      "credit_note_number": "<string>",
      "reason": "<string>",
      "total": "<string>",
      "voided_at": "2022-05-01T07:01:31+00:00",
      "type": "<string>",
      "memo": "<string>"
    }
  ],
  "payment_attempts": [
    {
      "id": "<string>",
      "payment_provider": "stripe",
      "payment_provider_id": "<string>",
      "amount": "<string>",
      "succeeded": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "invoice_date": "2022-05-01T07:00:00+00:00"
}

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Path Parameters

invoice_id

string

required

Response

200

application/json

An Invoice is a fundamental billing entity, representing the request for payment for a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as the result of an action, such as a cancellation.

metadata

object

required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

voided_at

string | null

required

If the invoice has a status of void, this gives a timestamp when the invoice was voided.

paid_at

string | null

required

If the invoice has a status of paid, this gives a timestamp when the invoice was paid.

issued_at

string | null

required

If the invoice has been issued, this will be the time it transitioned to issued (even if it is now in a different state.)

scheduled_issue_at

string | null

required

If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued.

auto_collection

object

required

issue_failed_at

string | null

required

If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)

sync_failed_at

string | null

required

If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be null for invoices using Orb Invoicing.

payment_failed_at

string | null

required

If payment was attempted on this invoice but failed, this will be the time of the most recent attempt.

payment_started_at

string | null

required

If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more.

amount_due

string

required

This is the final amount required to be charged to the customer and reflects the application of the customer balance to the total of the invoice.

Example:

"8.00"

created_at

string

required

The creation time of the resource in Orb.

Example:

"2022-05-01T07:01:31+00:00"

currency

string

required

An ISO 4217 currency string or credits

Example:

"USD"

customer

object

required

discount

any | null

required

deprecated

This field is deprecated in favor of discounts. If a discounts list is provided, the first discount in the list will be returned. If the list is empty, None will be returned.

discounts

object[]

required

discounts.discount_type

enum<string>

required

Available options:

percentage

discounts.applies_to_price_ids

string[]

required

List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

discounts.percentage_discount

number

required

Only available if discount_type is percentage. This is a number between 0 and 1.

Required range: 0 <= x <= 1

Example:

0.15

discounts.reason

string | null

due_date

string | null

required

When the invoice payment is due. The due date is null if the invoice is not yet finalized.

Example:

"2022-05-30T07:00:00+00:00"

string

required

invoice_pdf

string | null

required

The link to download the PDF representation of the Invoice.

Example:

"https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"

invoice_number

string

required

Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as RFOBWG. These can be sequential per account or customer.

Example:

"JYEFHK-00001"

minimum

object | null

required

minimum_amount

string | null

required

maximum

object | null

required

maximum_amount

string | null

required

line_items

object[]

required

The breakdown of prices in this invoice.

line_items.amount

string

required

The final amount for a line item after all adjustments and pre paid credits have been applied.

Example:

"7.00"

line_items.discount

object | null

required

line_items.discount.discount_type

enum<string>

required

Available options:

percentage

line_items.discount.applies_to_price_ids

string[]

required

List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

line_items.discount.percentage_discount

number

required

Only available if discount_type is percentage. This is a number between 0 and 1.

Required range: 0 <= x <= 1

Example:

0.15

line_items.discount.reason

string | null

line_items.end_date

string

required

The end date of the range of time applied for this line item's price.

Example:

"2022-02-01T08:00:00+00:00"

line_items.grouping

string | null

required

[DEPRECATED] For configured prices that are split by a grouping key, this will be populated with the key and a value. The amount and subtotal will be the values for this particular grouping.

line_items.minimum

object | null

required

deprecated

This field is deprecated in favor of adjustments.

line_items.minimum_amount

string | null

required

deprecated

This field is deprecated in favor of adjustments.

line_items.maximum

object | null

required

deprecated

This field is deprecated in favor of adjustments.

line_items.maximum_amount

string | null

required

deprecated

This field is deprecated in favor of adjustments.

line_items.adjustments

object[]

required

All adjustments applied to the line item in the order they were applied based on invoice calculations (ie. usage discounts -> amount discounts -> percentage discounts -> minimums -> maximums).

line_items.name

string

required

The name of the price associated with this line item.

Example:

"Fixed Fee"

line_items.quantity

number

required

Either the fixed fee quantity or the usage during the service period.

Example:

1

line_items.start_date

string

required

The start date of the range of time applied for this line item's price.

Example:

"2022-02-01T08:00:00+00:00"

line_items.subtotal

string

required

The line amount before before any adjustments.

Example:

"9.00"

line_items.adjusted_subtotal

string

required

The line amount after any adjustments and before overage conversion, credits and partial invoicing.

Example:

"5.00"

line_items.credits_applied

string

required

The number of prepaid credits applied.

Example:

"6.00"

line_items.partially_invoiced_amount

string

required

Any amount applied from a partial invoice

Example:

"4.00"

line_items.sub_line_items

object[]

required

For complex pricing structures, the line item can be broken down further in sub_line_items.

line_items.tax_amounts

object[]

required

An array of tax rates and their incurred tax amounts. Empty if no tax integration is configured.

line_items.id

string

required

A unique ID for this line item.

line_items.price

object | null

required

The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.

Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.

For more on the types of prices, see the core concepts documentation

line_items.price.metadata

object

required

line_items.price.id

string

required

line_items.price.name

string

required

line_items.price.external_price_id

string | null

required

line_items.price.price_type

enum<string>

required

Available options:

usage_price,

fixed_price

line_items.price.model_type

enum<string>

required

Available options:

unit

line_items.price.created_at

string

required

line_items.price.cadence

enum<string>

required

Available options:

one_time,

monthly,

quarterly,

semi_annual,

annual,

custom

line_items.price.billing_cycle_configuration

object

required

line_items.price.invoicing_cycle_configuration

object | null

required

line_items.price.billable_metric

object | null

required

line_items.price.fixed_price_quantity

number | null

required

line_items.price.plan_phase_order

integer | null

required

line_items.price.currency

string

required

line_items.price.conversion_rate

number | null

required

line_items.price.item

object

required

line_items.price.credit_allocation

object | null

required

line_items.price.discount

object | null

required

line_items.price.discount.discount_type

enum<string>

required

Available options:

percentage

line_items.price.discount.applies_to_price_ids

string[]

required

List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.

Example:

["h74gfhdjvn7ujokd", "7hfgtgjnbvc3ujkl"]

line_items.price.discount.percentage_discount

number

required

Only available if discount_type is percentage. This is a number between 0 and 1.

Required range: 0 <= x <= 1

Example:

0.15

line_items.price.discount.reason

string | null

line_items.price.minimum

object | null

required

line_items.price.minimum_amount

string | null

required

line_items.price.maximum

object | null

required

line_items.price.maximum_amount

string | null

required

line_items.price.unit_config

object

required

line_items.price.dimensional_price_configuration

object | null

line_items.usage_customer_ids

string[] | null

required

A list of customer ids that were used to calculate the usage for this line item.

line_items.filter

string | null

required

An additional filter that was used to calculate the usage for this line item.

subscription

object | null

required

subtotal

string

required

The total before any discounts and minimums are applied.

Example:

"8.00"

total

string

required

The total after any minimums and discounts have been applied.

Example:

"8.00"

customer_balance_transactions

object[]

required

status

enum<string>

required

Available options:

issued,

paid,

synced,

void,

draft

invoice_source

enum<string>

required

Available options:

subscription,

partial,

one_off

shipping_address

object | null

required

billing_address

object | null

required

hosted_invoice_url

string | null

required

A URL for the customer-facing invoice portal. This URL expires 30 days after the invoice's due date, or 60 days after being re-generated through the UI.

will_auto_issue

boolean

required

This is true if the invoice will be automatically issued in the future, and false otherwise.

eligible_to_issue_at

string | null

required

If the invoice has a status of draft, this will be the time that the invoice will be eligible to be issued, otherwise it will be null. If auto-issue is true, the invoice will automatically begin issuing at this time.

customer_tax_id

object | null

required

Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.

Supported Tax ID Countries and Types

Country	Type	Description
Andorra	`ad_nrt`	Andorran NRT Number
Argentina	`ar_cuit`	Argentinian Tax ID Number
Australia	`au_abn`	Australian Business Number (AU ABN)
Australia	`au_arn`	Australian Taxation Office Reference Number
Austria	`eu_vat`	European VAT Number
Bahrain	`bh_vat`	Bahraini VAT Number
Belgium	`eu_vat`	European VAT Number
Bolivia	`bo_tin`	Bolivian Tax ID
Brazil	`br_cnpj`	Brazilian CNPJ Number
Brazil	`br_cpf`	Brazilian CPF Number
Bulgaria	`bg_uic`	Bulgaria Unified Identification Code
Bulgaria	`eu_vat`	European VAT Number
Canada	`ca_bn`	Canadian BN
Canada	`ca_gst_hst`	Canadian GST/HST Number
Canada	`ca_pst_bc`	Canadian PST Number (British Columbia)
Canada	`ca_pst_mb`	Canadian PST Number (Manitoba)
Canada	`ca_pst_sk`	Canadian PST Number (Saskatchewan)
Canada	`ca_qst`	Canadian QST Number (Québec)
Chile	`cl_tin`	Chilean TIN
China	`cn_tin`	Chinese Tax ID
Colombia	`co_nit`	Colombian NIT Number
Costa Rica	`cr_tin`	Costa Rican Tax ID
Croatia	`eu_vat`	European VAT Number
Cyprus	`eu_vat`	European VAT Number
Czech Republic	`eu_vat`	European VAT Number
Denmark	`eu_vat`	European VAT Number
Dominican Republic	`do_rcn`	Dominican RCN Number
Ecuador	`ec_ruc`	Ecuadorian RUC Number
Egypt	`eg_tin`	Egyptian Tax Identification Number
El Salvador	`sv_nit`	El Salvadorian NIT Number
Estonia	`eu_vat`	European VAT Number
EU	`eu_oss_vat`	European One Stop Shop VAT Number for non-Union scheme
Finland	`eu_vat`	European VAT Number
France	`eu_vat`	European VAT Number
Georgia	`ge_vat`	Georgian VAT
Germany	`eu_vat`	European VAT Number
Greece	`eu_vat`	European VAT Number
Hong Kong	`hk_br`	Hong Kong BR Number
Hungary	`eu_vat`	European VAT Number
Hungary	`hu_tin`	Hungary Tax Number (adószám)
Iceland	`is_vat`	Icelandic VAT
India	`in_gst`	Indian GST Number
Indonesia	`id_npwp`	Indonesian NPWP Number
Ireland	`eu_vat`	European VAT Number
Israel	`il_vat`	Israel VAT
Italy	`eu_vat`	European VAT Number
Japan	`jp_cn`	Japanese Corporate Number (Hōjin Bangō)
Japan	`jp_rn`	Japanese Registered Foreign Businesses' Registration Number (Tōroku Kokugai Jigyōsha no Tōroku Bangō)
Japan	`jp_trn`	Japanese Tax Registration Number (Tōroku Bangō)
Kazakhstan	`kz_bin`	Kazakhstani Business Identification Number
Kenya	`ke_pin`	Kenya Revenue Authority Personal Identification Number
Latvia	`eu_vat`	European VAT Number
Liechtenstein	`li_uid`	Liechtensteinian UID Number
Lithuania	`eu_vat`	European VAT Number
Luxembourg	`eu_vat`	European VAT Number
Malaysia	`my_frp`	Malaysian FRP Number
Malaysia	`my_itn`	Malaysian ITN
Malaysia	`my_sst`	Malaysian SST Number
Malta	`eu_vat`	European VAT Number
Mexico	`mx_rfc`	Mexican RFC Number
Netherlands	`eu_vat`	European VAT Number
New Zealand	`nz_gst`	New Zealand GST Number
Nigeria	`ng_tin`	Nigerian Tax Identification Number
Norway	`no_vat`	Norwegian VAT Number
Norway	`no_voec`	Norwegian VAT on e-commerce Number
Oman	`om_vat`	Omani VAT Number
Peru	`pe_ruc`	Peruvian RUC Number
Philippines	`ph_tin`	Philippines Tax Identification Number
Poland	`eu_vat`	European VAT Number
Portugal	`eu_vat`	European VAT Number
Romania	`eu_vat`	European VAT Number
Romania	`ro_tin`	Romanian Tax ID Number
Russia	`ru_inn`	Russian INN
Russia	`ru_kpp`	Russian KPP
Saudi Arabia	`sa_vat`	Saudi Arabia VAT
Serbia	`rs_pib`	Serbian PIB Number
Singapore	`sg_gst`	Singaporean GST
Singapore	`sg_uen`	Singaporean UEN
Slovakia	`eu_vat`	European VAT Number
Slovenia	`eu_vat`	European VAT Number
Slovenia	`si_tin`	Slovenia Tax Number (davčna številka)
South Africa	`za_vat`	South African VAT Number
South Korea	`kr_brn`	Korean BRN
Spain	`es_cif`	Spanish NIF Number (previously Spanish CIF Number)
Spain	`eu_vat`	European VAT Number
Sweden	`eu_vat`	European VAT Number
Switzerland	`ch_vat`	Switzerland VAT Number
Taiwan	`tw_vat`	Taiwanese VAT
Thailand	`th_vat`	Thai VAT
Turkey	`tr_tin`	Turkish Tax Identification Number
Ukraine	`ua_vat`	Ukrainian VAT
United Arab Emirates	`ae_trn`	United Arab Emirates TRN
United Kingdom	`eu_vat`	Northern Ireland VAT Number
United Kingdom	`gb_vat`	United Kingdom VAT Number
United States	`us_ein`	United States EIN
Uruguay	`uy_ruc`	Uruguayan RUC Number
Venezuela	`ve_rif`	Venezuelan RIF Number
Vietnam	`vn_tin`	Vietnamese Tax ID Number

memo

string | null

required

Free-form text which is available on the invoice PDF and the Orb invoice portal.

credit_notes

object[]

required

A list of credit notes associated with the invoice

payment_attempts

object[]

required

A list of payment attempts associated with the invoice

invoice_date

string

required

The scheduled date of the invoice

Example:

"2022-05-01T07:00:00+00:00"

Was this page helpful?

Pay invoice List items

curl --request POST \
  --url https://api.withorb.com/v1/invoices/{invoice_id}/void \
  --header 'Authorization: Bearer <token>'

{
  "metadata": {},
  "voided_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "scheduled_issue_at": "2023-11-07T05:31:56Z",
  "auto_collection": {
    "next_attempt_at": "2023-11-07T05:31:56Z",
    "previously_attempted_at": "2023-11-07T05:31:56Z",
    "enabled": true,
    "num_attempts": 123
  },
  "issue_failed_at": "2023-11-07T05:31:56Z",
  "sync_failed_at": "2023-11-07T05:31:56Z",
  "payment_failed_at": "2023-11-07T05:31:56Z",
  "payment_started_at": "2023-11-07T05:31:56Z",
  "amount_due": "8.00",
  "created_at": "2022-05-01T07:01:31+00:00",
  "currency": "USD",
  "customer": {
    "id": "<string>",
    "external_customer_id": "<string>"
  },
  "discount": "<any>",
  "discounts": [
    {
      "discount_type": "percentage",
      "applies_to_price_ids": [
        "h74gfhdjvn7ujokd",
        "7hfgtgjnbvc3ujkl"
      ],
      "reason": "<string>",
      "percentage_discount": 0.15
    }
  ],
  "due_date": "2022-05-30T07:00:00+00:00",
  "id": "<string>",
  "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
  "invoice_number": "JYEFHK-00001",
  "minimum": {
    "minimum_amount": "<string>",
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "minimum_amount": "<string>",
  "maximum": {
    "maximum_amount": "<string>",
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "maximum_amount": "<string>",
  "line_items": [
    {
      "amount": "7.00",
      "discount": {
        "discount_type": "percentage",
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "reason": "<string>",
        "percentage_discount": 0.15
      },
      "end_date": "2022-02-01T08:00:00+00:00",
      "grouping": "<string>",
      "minimum": {
        "minimum_amount": "<string>",
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "minimum_amount": "<string>",
      "maximum": {
        "maximum_amount": "<string>",
        "applies_to_price_ids": [
          "<string>"
        ]
      },
      "maximum_amount": "<string>",
      "adjustments": [
        {
          "id": "<string>",
          "is_invoice_level": true,
          "applies_to_price_ids": [
            "<string>"
          ],
          "reason": "<string>",
          "adjustment_type": "usage_discount",
          "usage_discount": 123,
          "amount": "<string>"
        }
      ],
      "name": "Fixed Fee",
      "quantity": 1,
      "start_date": "2022-02-01T08:00:00+00:00",
      "subtotal": "9.00",
      "adjusted_subtotal": "5.00",
      "credits_applied": "6.00",
      "partially_invoiced_amount": "4.00",
      "sub_line_items": [
        {
          "amount": "9.00",
          "name": "Tier One",
          "quantity": 5,
          "grouping": {
            "key": "region",
            "value": "west"
          },
          "type": "matrix",
          "matrix_config": {
            "dimension_values": [
              "<string>"
            ]
          }
        }
      ],
      "tax_amounts": [
        {
          "tax_rate_description": "<string>",
          "tax_rate_percentage": "<string>",
          "amount": "<string>"
        }
      ],
      "id": "<string>",
      "price": {
        "metadata": {},
        "id": "<string>",
        "name": "<string>",
        "external_price_id": "<string>",
        "price_type": "usage_price",
        "model_type": "unit",
        "created_at": "2023-11-07T05:31:56Z",
        "cadence": "one_time",
        "billing_cycle_configuration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "invoicing_cycle_configuration": {
          "duration": 123,
          "duration_unit": "day"
        },
        "billable_metric": {
          "id": "<string>"
        },
        "dimensional_price_configuration": {
          "dimensional_price_group_id": "<string>",
          "dimension_values": [
            "<string>"
          ]
        },
        "fixed_price_quantity": 123,
        "plan_phase_order": 123,
        "currency": "<string>",
        "conversion_rate": 123,
        "item": {
          "id": "<string>",
          "name": "<string>"
        },
        "credit_allocation": {
          "currency": "<string>",
          "allows_rollover": true
        },
        "discount": {
          "discount_type": "percentage",
          "applies_to_price_ids": [
            "h74gfhdjvn7ujokd",
            "7hfgtgjnbvc3ujkl"
          ],
          "reason": "<string>",
          "percentage_discount": 0.15
        },
        "minimum": {
          "minimum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "minimum_amount": "<string>",
        "maximum": {
          "maximum_amount": "<string>",
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "unit_config": {
          "unit_amount": "<string>"
        }
      },
      "usage_customer_ids": [
        "<string>"
      ],
      "filter": "<string>"
    }
  ],
  "subscription": {
    "id": "VDGsT23osdLb84KD"
  },
  "subtotal": "8.00",
  "total": "8.00",
  "customer_balance_transactions": [
    {
      "id": "cgZa3SXcsPTVyC4Y",
      "created_at": "2022-05-01T07:01:31+00:00",
      "starting_balance": "33.00",
      "ending_balance": "22.00",
      "amount": "11.00",
      "action": "applied_to_invoice",
      "description": "An optional description",
      "invoice": {
        "id": "gXcsPTVyC4YZa3Sc"
      },
      "type": "increment",
      "credit_note": {
        "id": "<string>"
      }
    }
  ],
  "status": "issued",
  "invoice_source": "subscription",
  "shipping_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "hosted_invoice_url": "<string>",
  "will_auto_issue": true,
  "eligible_to_issue_at": "2023-11-07T05:31:56Z",
  "customer_tax_id": {
    "country": "AD",
    "type": "ad_nrt",
    "value": "<string>"
  },
  "memo": "<string>",
  "credit_notes": [
    {
      "id": "<string>",
      "credit_note_number": "<string>",
      "reason": "<string>",
      "total": "<string>",
      "voided_at": "2022-05-01T07:01:31+00:00",
      "type": "<string>",
      "memo": "<string>"
    }
  ],
  "payment_attempts": [
    {
      "id": "<string>",
      "payment_provider": "stripe",
      "payment_provider_id": "<string>",
      "amount": "<string>",
      "succeeded": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "invoice_date": "2022-05-01T07:00:00+00:00"
}

API documentation

Alert

Coupon

Credit note

Customer

Credit

Dimensional Price Group

Event

Invoice

Item

Metric

Availability

Plan

Price

Subscription

Price interval

Void invoice

Authorizations

Path Parameters

Response

Supported Tax ID Countries and Types