Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Subscription Bills

Void a bill

Voids an existing bill. This status change is irreversible. Only bills with status 'draft', 'open', 'past_due' or 'paid' can be voided. This prevents payment attempts for this specific bill.

post/subscriptions/{subscription_id}/bills/{bill_id}/void

Path parameters

subscription_idstring required
Example:01HNY4G8G5ZMAXQB8T0Z1Y1ZMW

Unique identifier for the subscription.

bill_idstring required
Example:01HNY4G8G8P4E1T4YJ9N8B1Z9M

Unique identifier for the bill.

Response

Bill voided successfully.

idstring required

Unique ID assigned by Acquired to the bill when it is created.

subscription_idstring required

ID of the subscription this bill belongs to.

status'draft' | 'open' | 'paid' | 'void' | 'past_due' | 'unpaid' required

Current lifecycle status of the bill.

currencystring required

The currency the bill is denominated in.

due_datestring date-time required

When this bill is due to be paid.

created_atstring date-time required

When the bill record was created.

Example response

{
  "id": "01HNY4G8G8P4E1T4YJ9N8B1Z9M",
  "subscription_id": "01HNY4G8G5ZMAXQB8T0Z1Y1ZMW",
  "customer": {
    "customer_id": "c3e06b6f-bb52-4b2c-81a3-899860652240"
  },
  "status": "paid",
  "amount": {
    "base": 19.99,
    "discount": 4,
    "total": 15.99,
    "status": "finalised"
  },
  "currency": "GBP",
  "due_date": "2025-11-17T17:00:00Z",
  "transactions": [
    {
      "transaction_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "success",
      "type": "payment",
      "payment_method": "card"
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "/v1/subscriptions/01HNY4G8G5ZMAXQB8T0Z1Y1ZMW/bills/01HNY4G8G8P4E1T4YJ9N8B1Z9M",
      "method": "GET"
    }
  ]
}