Skip to main content
POST
Void an invoice

Authorizations

x-api-key
string
header
required

API key for authentication (required)

x-merchant-id
string
header
required

Merchant ID for identifying the merchant (required)

Path Parameters

id
string<uuid>
required

Invoice unique identifier

Response

Invoice voided successfully

id
string<uuid>
required

Unique invoice identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

subscriptionId
string<uuid>
required

Associated subscription ID

Example:

"123e4567-e89b-12d3-a456-426614174001"

amount
string
required

Invoice amount in smallest currency unit

Example:

"9900"

currency
string
required

Currency code

Example:

"MXN"

status
enum<string>
required

Invoice status

Available options:
DRAFT,
OPEN,
PAID,
VOID,
UNCOLLECTIBLE
Example:

"PAID"

periodStart
string<date-time>
required

Billing period start

Example:

"2025-01-01T00:00:00.000Z"

periodEnd
string<date-time>
required

Billing period end

Example:

"2025-02-01T00:00:00.000Z"

dueDate
string<date-time>
required

Payment due date

Example:

"2025-01-01T00:00:00.000Z"

attemptCount
integer
required

Number of payment attempts

Example:

1

maxRetries
integer
required

Maximum number of retry attempts

Example:

3

createdAt
string<date-time>
required

Creation timestamp

Example:

"2025-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2025-01-01T12:00:00.000Z"

paymentOrderId
string<uuid> | null

Associated payment order ID

Example:

"123e4567-e89b-12d3-a456-426614174002"

paidAt
string<date-time> | null

When the invoice was paid

Example:

"2025-01-01T12:00:00.000Z"

nextRetryAt
string<date-time> | null

Next retry attempt date

Example:

null

lastFailureReason
string | null

Reason for the last failed payment attempt

Example:

null

metadata
object | null

Additional metadata

subscription
object

Associated subscription details