v1

latestOpenAPI 3.1.02026-07-24820248.4 KB

Obtener Invoice

get/invoices/{id}

Path parameters

idstring required

ID del Invoice entregado en su creación.

Headers

x-account-keystring

Llave única que identifica la Cuenta de cobro

x-api-versionstring

Response

200

customerstring
product_idstring
subscriptionstring
is_paidboolean
due_datestring
is_voidboolean
amountinteger
link_paymentstring
{"stackTrail":"paths:/invoices/{id}:get:responses:200:content:application/json:schema:properties:receipt_type","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices/{id}:get:responses:200:content:application/json:schema:properties:id_receipt","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/invoices/{id}:get:responses:200:content:application/json:schema:properties:source","oasType":"schema","type":"unknown"}
disable_automatic_paymentboolean
currency_codestring
invoice_external_idstring
statusstring
idstring
paid_amountinteger

Example response

{
  "customer": "cus_M2aYvh3QOfVylcre5gIMyIhYPrHBKfw2",
  "product_id": "92792",
  "subscription": "sub_AmT67cjfrpaNXOmhXGvdJiqHuYmM-kgE",
  "due_date": "2023-03-02",
  "amount": 1000,
  "link_payment": "https://portal.pagos.com/tu-empresa",
  "metadata": {
    "car_brand": "Toyota",
    "car_model": "Yaris"
  },
  "currency_code": "CLP",
  "invoice_external_id": "92792-2023-03-02",
  "status": "UNPAID",
  "id": "in_K3a1P1_p_t5UHJHJXmpkQYmqXCHvXrNi"
}