Charge invoice

POST

invoices

{id}

charge

curl --request POST \
  --url https://api.hyperline.co/v1/invoices/{id}/charge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_method_id": "pm_1xMpj5bwRqN7LM"
}'

{
  "id": "inv_1eTaiytfA0i2Va",
  "number": "INV-35",
  "type": "invoice",
  "document_name": "<string>",
  "status": "paid",
  "reference": "V0KAHOU6J3",
  "purchase_order": "PO-12345",
  "original_invoice_id": "<string>",
  "original_invoice_number": "<string>",
  "currency": "EUR",
  "total_amount": 24000,
  "amount_due": 0,
  "amount_paid": 24000,
  "amount_fixed": 20000,
  "amount_excluding_tax": 20000,
  "tax_rate": 20,
  "tax_amount": 4000,
  "tax_scheme": "standard",
  "discount_amount": 0,
  "conversion_rate": 1,
  "converted_amount": 24000,
  "converted_at": "2024-10-13T02:00:00.000Z",
  "payment_method_id": "pm_1ryTrMj4TTAT1N",
  "custom_note": "Thank you for your purchase!",
  "customer": {
    "id": "cus_Typ0px2W0aiEtl",
    "name": "Acme",
    "email": "billing@acme.com",
    "external_id": "<string>",
    "vat_number": "FR123456789",
    "address": {
      "name": "Acme",
      "line1": "5 rue de Paradis",
      "line2": "<string>",
      "city": "Paris",
      "zip": "75010",
      "state": "<string>",
      "country": "FR"
    }
  },
  "seller": {
    "id": "ive_47484fjdhy5",
    "name": "Name of the invoicing entity",
    "tax_id": "FR5878986578",
    "address": {
      "name": "Acme",
      "line1": "5 rue de Paradis",
      "line2": "<string>",
      "city": "Paris",
      "zip": "75010",
      "state": "<string>",
      "country": "FR"
    }
  },
  "subscription_id": "sub_amiaWZ3lzDIWaoT",
  "period_starts_at": "2024-10-13T00:00:00.000Z",
  "period_ends_at": "2024-11-13T00:00:00.000Z",
  "emitted_at": "2024-10-13T00:00:00.000Z",
  "due_at": "2024-11-12T00:00:00.000Z",
  "refunded_at": "2024-10-13T02:00:00.000Z",
  "grace_period_ended_at": "2024-10-13T02:00:00.000Z",
  "settled_at": "2024-10-15T14:01:56.000Z",
  "updated_at": "2024-10-15T14:01:56.000Z",
  "line_items": [
    {
      "id": "ili_0FACNpeoEFkGu3",
      "name": "Platform access",
      "product_id": "itm_KbLcWt2qm5p1S2",
      "product_type": "flat_fee",
      "units_count": 1,
      "unit_amount": 24000,
      "amount": 24000,
      "amount_excluding_tax": 20000,
      "tax_rate": 20,
      "tax_rate_id": "<string>",
      "tax_amount": 4000,
      "discount_amount": 0,
      "discount_percent": 123,
      "period_starts_at": "2024-10-13T00:00:00.000Z",
      "period_ends_at": "2024-11-13T00:00:00.000Z"
    }
  ],
  "transactions": [
    {
      "id": "tra_2QdJDDUej969ev",
      "type": "subscription",
      "amount": 31500,
      "currency": "EUR",
      "customer_id": "cus_QalW2vTAdkR6IY",
      "provider_id": "pi_xxxxxxxxxx",
      "process_at": "2024-11-12T07:38:39.222Z",
      "refunded_at": "2024-10-13T02:00:00.000Z",
      "last_refreshed_at": "2024-10-13T02:00:00.000Z",
      "provider_fee": {
        "amount": 24000,
        "currency": "EUR",
        "exchange_rate": 123
      },
      "chargeback": {
        "amount": 31500,
        "last_chargeback_at": "2024-10-13T10:00:01.860Z"
      },
      "payment_method_type": "card",
      "payment_method": {
        "id": "pm_1xMpj5bwRqN7LM",
        "status": "active",
        "type": "card",
        "last_4_digits": 2718,
        "expiration_date": "2026-11",
        "brand": "visa"
      },
      "status": "settled"
    }
  ],
  "coupons": [
    {
      "id": "cou_DKL4Xcb5VSa8CQ",
      "name": "Partner discount",
      "discount_amount": 2000,
      "discount_percent": 123,
      "line_item_ids": [
        "ili_0FACNpeoEFkGu3"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

payment_method_id

string

Payment method used to execute the payment. This payment method will override any previously set method on the invoice.

Example:

"pm_1xMpj5bwRqN7LM"

Response

200 - application/json

string

required

Invoice ID.

Example:

"inv_1eTaiytfA0i2Va"

number

string

required

Invoice number. Generated by Hyperline using the sequential numbering and format defined in your settings.

Example:

"INV-35"

type

enum<string>

required

Type of the invoice.

invoice: Legal invoice to be paid by your customer.
credit_note: Legal credit note cancelling an invoice and refunding your customer.
document: Custom document with no legal value. Can be generated from a subscription to meet specific needs.

Available options:

invoice,

credit_note,

document,

child_invoice_ref,

child_creditnote_ref

Example:

"invoice"

document_name

string | null

required

If the invoice is of type document you can give it a custom name (displayed on the final PDF).

status

enum<string>

required

Current invoice status.

draft: Invoice is in draft mode (not finalized yet).
open: Invoice for the current billing period, which will be issued at the end of the period (used for invoices with usage-based data).
grace_period: Invoice is in a review period after being issued for the billing period and before becoming due for payment.
to_pay: Invoice is awaiting payment.
partially_paid: Invoice is partially paid.
paid: Invoice is fully paid.
voided: Invoice has been voided and is no longer valid.
closed: Invoice was not issued and has been discarded.
error: Invoice failed to be paid.
archived: A previous version of an invoice.
charged_on_parent: Invoice is charged on the parent customer.
pending_parent_concat: Invoice is pending invoices concatenation on the parent customer to be grouped.

Available options:

draft,

open,

to_pay,

grace_period,

partially_paid,

paid,

voided,

closed,

error,

missing_info,

archived,

charged_on_parent,

pending_parent_concat

Example:

"paid"

reference

string | null

required

Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.

Example:

"V0KAHOU6J3"

purchase_order

string | null

required

Reference to the purchase order linked to the invoice.

Example:

"PO-12345"

original_invoice_id

string | null

required

ID of the original invoice this credit note is linked to (only used for credit note).

original_invoice_number

string | null

required

Number of the original invoice this credit note is linked to (only used for credit note).

currency

enum<string>

required

Currency code. See ISO 4217.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

XOF,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

total_amount

number

required

Sum of the amount and taxes amount of all products on the invoice. Expressed in the currency's smallest unit.

Example:

24000

amount_due

number

required

Amount still need to be paid for the invoice. Expressed in the currency's smallest unit.

Example:

0

amount_paid

number

required

Amount already paid for the invoice. Expressed in the currency's smallest unit.

Example:

24000

amount_fixed

number

required

Amount corresponding to the recurring non-variable part of the total amount. Expressed in the currency's smallest unit.

Example:

20000

amount_excluding_tax

number

required

Total amount without the taxes amount. Expressed in the currency's smallest unit.

Example:

20000

tax_rate

number

required

Tax amount of the invoice. Expressed in the currency's smallest unit.

Example:

20

tax_amount

number

required

Tax amount of the invoice. Expressed in the currency's smallest unit.

Example:

4000

tax_scheme

enum<string>

required

Tax scheme of the invoice.

standard: Tax rate is resolved depending on local tax regulations.
exempt: No tax rate applied because the customer country doesn't require it.
reverse_charge: No tax rate applied because the customer is eligible to EU reverse charge.
manual: Tax rate has been manually specified when creating the invoice.
not_eligible: Tax collection is disabled for the invoice.

Available options:

exempt,

standard,

reverse_charge,

manual,

not_eligible

Example:

"standard"

discount_amount

number

required

Amount corresponding to the discounted part of the total amount. Expressed in the currency's smallest unit.

Example:

0

conversion_rate

number | null

required

Conversion rate used between the invoice currency and your accounting currency.

Example:

1

converted_amount

number

required

Amount converted using the conversion rate. Expressed in the currency's smallest unit.

Example:

24000

converted_at

string | null

required

Date of the conversion of the amount.

Example:

"2024-10-13T02:00:00.000Z"

payment_method_id

string | null

required

ID of the payment method used to pay the invoice.

Example:

"pm_1ryTrMj4TTAT1N"

custom_note

string | null

required

Custom note added to the invoice.

Example:

"Thank you for your purchase!"

customer

object

required

customer.id

string

required

Customer ID.

Example:

"cus_Typ0px2W0aiEtl"

customer.name

string

required

Customer name.

Example:

"Acme"

customer.email

string | null

required

Email to which all communications will be sent.

Example:

"billing@acme.com"

customer.external_id

string | null

required

ID of the customer in your system. This helps matching your customer with the one on Hyperline.

customer.vat_number

string | null

required

Customer tax ID.

Example:

"FR123456789"

customer.address

object | null

required

Customer billing address.

seller

object

required

subscription_id

string | null

required

ID of the subscription related to the invoice.

Example:

"sub_amiaWZ3lzDIWaoT"

period_starts_at

string | null

required

Start date of the billing period of the invoice.

Example:

"2024-10-13T00:00:00.000Z"

period_ends_at

string | null

required

End date of the billing period of the invoice.

Example:

"2024-11-13T00:00:00.000Z"

emitted_at

string

required

Emission date of the invoice.

Example:

"2024-10-13T00:00:00.000Z"

due_at

string

required

Due date of the invoice. Computed from the emission date and the payment delay configured in your settings.

Example:

"2024-11-12T00:00:00.000Z"

refunded_at

string | null

required

Date corresponding to the refund of the invoice, previously paid. A credit note exists with an original invoice ID equals to this invoice ID.

Example:

"2024-10-13T02:00:00.000Z"

grace_period_ended_at

string | null

required

Date the invoice grace period ended. This happens at the emission date + the grace period duration configured in your settings.

Example:

"2024-10-13T02:00:00.000Z"

settled_at

string | null

required

Date the invoice was fully paid.

Example:

"2024-10-15T14:01:56.000Z"

updated_at

string | null

required

Date of the last update

Example:

"2024-10-15T14:01:56.000Z"

line_items

object[]

required

line_items.id

string

required

Invoice line item ID.

Example:

"ili_0FACNpeoEFkGu3"

line_items.name

string

required

Name of the line item, corresponding to the related product.

Example:

"Platform access"

line_items.product_id

string | null

required

Product ID related to the invoice line item.

Example:

"itm_KbLcWt2qm5p1S2"

line_items.product_type

enum<string> | null

required

Product type related to the invoice line item.

Available options:

flat_fee,

seat,

dynamic,

credit

Example:

"flat_fee"

line_items.units_count

number

required

Count of units of the product related to the invoice line item.

Example:

1

line_items.unit_amount

number

required

Amount of one unit of the product related to the invoice line item. Expressed in the currency's smallest unit.

Example:

24000

line_items.amount

number

required

Total amount of the invoice line item. Expressed in the currency's smallest unit.

Example:

24000

line_items.amount_excluding_tax

number

required

Total amount without the taxes amount of the invoice line item. Expressed in the currency's smallest unit.

Example:

20000

line_items.tax_rate

number

required

Tax rate of the invoice line item.

Example:

20

line_items.tax_rate_id

string | null

required

Custom tax rate ID applied to the invoice line item.

line_items.tax_amount

number

required

Tax amount of the invoice line item. Expressed in the currency's smallest unit.

Example:

4000

line_items.discount_amount

number

required

Amount corresponding to the discounted part of the total amount of the invoice line item. Expressed in the currency's smallest unit.

Example:

0

line_items.discount_percent

number | null

required

Percentage applied to compute the discounted part of the invoice line amount. Only if coupons applied are percentage based.

line_items.period_starts_at

string | null

required

Start date of the period corresponding to the line item charge.

Example:

"2024-10-13T00:00:00.000Z"

line_items.period_ends_at

string | null

required

End date of the period corresponding to the line item charge.

Example:

"2024-11-13T00:00:00.000Z"

transactions

object[]

required

transactions.id

string

required

Transaction ID.

Example:

"tra_2QdJDDUej969ev"

transactions.type

enum<string>

required

Transaction type.

subscription: The transaction is related to a subscription payment.
one_time: The transaction is related to a one-time payment.
refund: The transaction is related to a refund payment.

Available options:

subscription,

one_time,

refund

Example:

"subscription"

transactions.amount

number

required

Transaction amount.

Example:

31500

transactions.currency

enum<string>

required

Transaction currency.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

XOF,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

transactions.customer_id

string

required

ID of the customer linked to the transaction.

Example:

"cus_QalW2vTAdkR6IY"

transactions.provider_id

string | null

required

ID of the transaction on the payment provider (Stripe, Mollie, GoCardless, ...) side.

Example:

"pi_xxxxxxxxxx"

transactions.process_at

string

required

Date corresponding to the processing of the transaction. If in the future, the transaction is scheduled to be processed.

Example:

"2024-11-12T07:38:39.222Z"

transactions.refunded_at

string | null

required

Date corresponding to the refund of the transaction.

Example:

"2024-10-13T02:00:00.000Z"

transactions.last_refreshed_at

string | null

required

Date corresponding to the last synchronization of the details with the payment provider.

Example:

"2024-10-13T02:00:00.000Z"

transactions.provider_fee

object | null

required

Fee applied by the Payment Service Provider. Only supported for Stripe.

transactions.chargeback

object | null

required

Chargeback details related to the transaction.

transactions.payment_method_type

enum<string>

required

Available options:

card,

direct_debit,

direct_debit_ach,

direct_debit_bacs

transactions.payment_method

object | null

required

transactions.status

enum<string>

required

Transaction status.

scheduled: The transaction is scheduled to be processed in the future.
to_process: The transaction is waiting to be processed by our system.
pending: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.
settled: The transaction has been cleared on the banking side, the money transfer is fully completed.
cancelled: The transaction has been cancelled and won't be processed again.

Available options:

scheduled,

to_process,

pending,

settled,

cancelled

Example:

"settled"

coupons

object[]

required

coupons.id

string | null

required

Coupon ID.

Example:

"cou_DKL4Xcb5VSa8CQ"

coupons.name

string | null

required

Coupon name.

Example:

"Partner discount"

coupons.discount_amount

number

required

Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.

Example:

2000

coupons.discount_percent

number | null

required

Percentage to apply as a discount on the amount (excluding taxes) of a product.

coupons.line_item_ids

string[]

required

IDs of the line items to which the coupon applies.

Example:

["ili_0FACNpeoEFkGu3"]

Was this page helpful?

Delete invoice Download invoice

curl --request POST \
  --url https://api.hyperline.co/v1/invoices/{id}/charge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_method_id": "pm_1xMpj5bwRqN7LM"
}'

{
  "id": "inv_1eTaiytfA0i2Va",
  "number": "INV-35",
  "type": "invoice",
  "document_name": "<string>",
  "status": "paid",
  "reference": "V0KAHOU6J3",
  "purchase_order": "PO-12345",
  "original_invoice_id": "<string>",
  "original_invoice_number": "<string>",
  "currency": "EUR",
  "total_amount": 24000,
  "amount_due": 0,
  "amount_paid": 24000,
  "amount_fixed": 20000,
  "amount_excluding_tax": 20000,
  "tax_rate": 20,
  "tax_amount": 4000,
  "tax_scheme": "standard",
  "discount_amount": 0,
  "conversion_rate": 1,
  "converted_amount": 24000,
  "converted_at": "2024-10-13T02:00:00.000Z",
  "payment_method_id": "pm_1ryTrMj4TTAT1N",
  "custom_note": "Thank you for your purchase!",
  "customer": {
    "id": "cus_Typ0px2W0aiEtl",
    "name": "Acme",
    "email": "billing@acme.com",
    "external_id": "<string>",
    "vat_number": "FR123456789",
    "address": {
      "name": "Acme",
      "line1": "5 rue de Paradis",
      "line2": "<string>",
      "city": "Paris",
      "zip": "75010",
      "state": "<string>",
      "country": "FR"
    }
  },
  "seller": {
    "id": "ive_47484fjdhy5",
    "name": "Name of the invoicing entity",
    "tax_id": "FR5878986578",
    "address": {
      "name": "Acme",
      "line1": "5 rue de Paradis",
      "line2": "<string>",
      "city": "Paris",
      "zip": "75010",
      "state": "<string>",
      "country": "FR"
    }
  },
  "subscription_id": "sub_amiaWZ3lzDIWaoT",
  "period_starts_at": "2024-10-13T00:00:00.000Z",
  "period_ends_at": "2024-11-13T00:00:00.000Z",
  "emitted_at": "2024-10-13T00:00:00.000Z",
  "due_at": "2024-11-12T00:00:00.000Z",
  "refunded_at": "2024-10-13T02:00:00.000Z",
  "grace_period_ended_at": "2024-10-13T02:00:00.000Z",
  "settled_at": "2024-10-15T14:01:56.000Z",
  "updated_at": "2024-10-15T14:01:56.000Z",
  "line_items": [
    {
      "id": "ili_0FACNpeoEFkGu3",
      "name": "Platform access",
      "product_id": "itm_KbLcWt2qm5p1S2",
      "product_type": "flat_fee",
      "units_count": 1,
      "unit_amount": 24000,
      "amount": 24000,
      "amount_excluding_tax": 20000,
      "tax_rate": 20,
      "tax_rate_id": "<string>",
      "tax_amount": 4000,
      "discount_amount": 0,
      "discount_percent": 123,
      "period_starts_at": "2024-10-13T00:00:00.000Z",
      "period_ends_at": "2024-11-13T00:00:00.000Z"
    }
  ],
  "transactions": [
    {
      "id": "tra_2QdJDDUej969ev",
      "type": "subscription",
      "amount": 31500,
      "currency": "EUR",
      "customer_id": "cus_QalW2vTAdkR6IY",
      "provider_id": "pi_xxxxxxxxxx",
      "process_at": "2024-11-12T07:38:39.222Z",
      "refunded_at": "2024-10-13T02:00:00.000Z",
      "last_refreshed_at": "2024-10-13T02:00:00.000Z",
      "provider_fee": {
        "amount": 24000,
        "currency": "EUR",
        "exchange_rate": 123
      },
      "chargeback": {
        "amount": 31500,
        "last_chargeback_at": "2024-10-13T10:00:01.860Z"
      },
      "payment_method_type": "card",
      "payment_method": {
        "id": "pm_1xMpj5bwRqN7LM",
        "status": "active",
        "type": "card",
        "last_4_digits": 2718,
        "expiration_date": "2026-11",
        "brand": "visa"
      },
      "status": "settled"
    }
  ],
  "coupons": [
    {
      "id": "cou_DKL4Xcb5VSa8CQ",
      "name": "Partner discount",
      "discount_amount": 2000,
      "discount_percent": 123,
      "line_item_ids": [
        "ili_0FACNpeoEFkGu3"
      ]
    }
  ]
}

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoices > Transactions

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Authorizations

Path Parameters

Body

Response