Invoices
Charge invoice
API documentation
Integrations
Analytics
Billable events
Companies
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Invoices
Charge invoice
Manually trigger the payment of the invoice.
POST
/
v1
/
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",
"bank_account_id": "bac_KJyPrMA1toAqRG",
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
Response
200 - application/json
The response is of type object
.
Was this page helpful?
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",
"bank_account_id": "bac_KJyPrMA1toAqRG",
"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"
]
}
]
}