v1
latestOpenAPI 3.1.02026-07-241040774.6 KBCancelar fatura
Com o verbo HTTP DELETE, através do identificador da fatura (invoice_id), este recurso possibilita realizar o cancelamento da fatura.
delete/invoices/{invoice_id}
Path parameters
invoice_idstring required
Código da fatura. <br>Formato: in_XXXXXXXXXXXXXXXX.
Response
200
Example response
{
"id": "in_n87qwY1FA2SzwXDb",
"code": "P47FWGIEZP",
"url": "/invoices/in_n87qwY1FA2SzwXDb",
"amount": 1490,
"status": "canceled",
"payment_method": "credit_card",
"due_at": "2017-04-04T00:00:00Z",
"canceled_at": "2017-04-04T15:48:48Z",
"created_at": "2017-04-04T15:40:28Z",
"items": [
{
"name": "Nome - teste",
"amount": 1490,
"quantity": 1,
"description": "Bola"
}
],
"customer": {
"id": "cus_J4wRXJ0U6ytZrpAx",
"name": "Tony Star8k",
"email": "tstark@avengers.com",
"created_at": "2016-09-28T21:04:37Z",
"updated_at": "2017-04-04T15:08:20Z"
},
"subscription": {
"id": "sub_KrmEXBxHVIRAJxDG",
"code": "KERZFJ6TQZ",
"start_at": "2017-04-04T00:00:00Z",
"interval": "month",
"interval_count": 1,
"billing_type": "postpaid",
"next_billing_at": "2017-05-04T00:00:00Z",
"payment_method": "credit_card",
"currency": "BRL",
"statement_descriptor": "Spotify",
"installments": 1,
"status": "active",
"created_at": "2017-04-04T15:10:01Z",
"updated_at": "2017-04-04T15:10:01Z"
},
"cycle": {
"id": "cycle_WE1ZYoX7uEfbRar4",
"start_at": "2017-04-04T00:00:00Z",
"end_at": "2017-05-03T23:59:59Z",
"billing_at": "2017-05-04T00:00:00Z"
},
"charge": {
"id": "ch_NnLXBY2sXxs0Z3Oy",
"code": "KERZFJ6TQZ-01",
"gateway_id": "453b685d-33aa-4fd9-a926-afd78dce2832",
"status": "canceled",
"currency": "BRL",
"payment_method": "credit_card",
"due_at": "2017-04-04T00:00:00Z",
"paid_at": "2017-04-04T15:40:30Z",
"canceled_at": "2017-04-04T15:48:48Z",
"created_at": "2017-04-04T15:40:28Z",
"updated_at": "2017-04-04T15:48:48Z",
"last_transaction": {
"id": "tran_jJ0n4JJsbKu88mL1",
"transaction_type": "credit_card",
"funding_source": "prepaid",
"gateway_id": "ab76139e-2c3b-40a0-89ed-98d451821c0c",
"amount": 1490,
"status": "voided",
"success": true,
"acquirer_name": "simulator",
"acquirer_affiliation_code": "MUNDI",
"acquirer_tid": "532840",
"acquirer_nsu": "805131",
"acquirer_auth_code": "557586",
"operation_type": "cancel",
"credit_card": {
"id": "card_pEYq7rDbFeiW8V6k",
"first_six_digits": "542501",
"last_four_digits": "8229",
"brand": "Amex",
"holder_name": "Tony Stark",
"exp_month": 1,
"exp_year": 2018,
"status": "active",
"created_at": "2016-11-16T17:02:39Z",
"updated_at": "2016-12-29T12:03:24Z",
"billing_address": {
"line_1": "10880, Malibu Point, Malibu Central",
"zip_code": "90265",
"city": "Malibu",
"state": "CA",
"country": "US"
}
},
"created_at": "2017-04-04T15:48:48Z",
"updated_at": "2017-04-04T15:48:48Z"
}
}
}