com.gigs.invoice.updated

Name
object
Type
string
Description
Type of object is always event.
Allowed values: event
Name
id
Type
string
Description
Unique identifier for the event.
Example: "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
Name
data
Type
Invoice
Description
Invoices represent the charges due to a user for a given subscription period, including any relevant taxes and fees.
Name
datacontenttype
Type
string
Description
The RFC 2046 content-type.
Example: "application/json"
Default: application/json
Name
previousData
Type
object
Description
Present only for events of type *.updated. Contains the values fields in the schema had prior to the update.

This field is the result of a shallow diff of the previous schema (i.e., if a nested field has changed, then the entire object will be included).
Optional: This property may not always be included.
Name
project
Type
string
Description
Unique identifier for the project where the event occurred.
Example: "gigs"
Name
source
Type
string
Description
URI identifying the event source.
Example: "https://api.gigs.com"
Default: https://api.gigs.com
Name
specversion
Type
string
Description
The CloudEvents spec version.
Example: "1.0"
Default: 1.0
Name
time
Type
string
Description
Time when the event occurred.
Example: "2022-03-16T14:12:42Z"
Name
type
Type
string
Description
Type is always com.gigs.invoice.updated.
Allowed values: com.gigs.invoice.updated
Name
version
Type
string
Description
API version used to serialize the data and the event itself.
Default: 2024-12-20

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "invoice",
    "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
    "createdAt": "2024-01-09T15:01:51.0Z",
    "discount": {
      "amount": 100,
      "currency": "USD"
    },
    "fees": [
      {
        "amount": {
          "amount": 100,
          "currency": "USD"
        },
        "name": "Recovery Fee",
        "type": "recoveryFee"
      }
    ],
    "finalizedAt": "2024-02-01T11:12:13Z",
    "lineItems": [
      {
        "object": "invoiceLineItem",
        "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
        "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
        "discount": {
          "amount": 100,
          "currency": "USD"
        },
        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
        "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
        "subtotal": {
          "amount": 999,
          "currency": "USD"
        },
        "tax": {
          "amount": 200,
          "currency": "USD"
        },
        "taxes": [
          {
            "object": "invoiceTax",
            "id": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3",
            "amount": {
              "amount": 200,
              "currency": "USD"
            },
            "inclusive": false,
            "jurisdiction": "Federal",
            "name": "Federal TRS Fund"
          }
        ],
        "total": {
          "amount": 1099,
          "currency": "USD"
        }
      }
    ],
    "paidAt": "2024-02-01T11:13:13Z",
    "payment": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
    "period": {
      "number": 1,
      "start": "2021-01-21T19:32:13.0Z",
      "end": "2021-02-20T19:38:34.0Z"
    },
    "reason": "other",
    "status": "draft",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "subtotal": {
      "amount": 999,
      "currency": "USD"
    },
    "tax": {
      "amount": 200,
      "currency": "USD"
    },
    "taxExemptionReason": "calculationFailed",
    "total": {
      "amount": 1199,
      "currency": "USD"
    }
  },
  "datacontenttype": "application/json",
  "previousData": {},
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42.0Z",
  "type": "com.gigs.invoice.updated",
  "version": "2024-12-20"
}