com.gigs.invoice.created

Name
object
Type
string
required
Description
Type of object is always event.
Name
id
Type
string
required
Description
Unique identifier for the event.
Example: evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
Name
data
Type
object
PREVIEW
required
Description
Invoices represent the charges due to a user for a given subscription period, including any relevant taxes and fees.
Name
datacontenttype
Type
string
required
Description
The RFC 2046 content-type.
Example: application/json
Default: application/json
Name
project
Type
string
required
Description
Unique identifier for the project where the event occurred.
Example: gigs
Name
source
Type
string
required
Description
URI identifying the event source.
Example: https://api.gigs.com
Default: https://api.gigs.com
Name
specversion
Type
string
required
Description
The CloudEvents spec version.
Example: 1.0
Default: 1.0
Name
time
Type
string
required
Description
Time when the event occurred.
Example: 2022-03-16T14:12:42Z
Name
type
Type
string
required
Description
Type is always com.gigs.invoice.created.
Name
version
Type
string
required
Description
API version used to serialize the data and the event itself.
Default: 2024-10-28

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "invoice",
    "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
    "discount": {
      "amount": 999,
      "currency": "USD"
    },
    "payment": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
    "period": {
      "number": 1,
      "start": "2021-01-21T19:32:13Z",
      "end": "2021-02-20T19:38:34Z"
    },
    "reason": "other",
    "status": "draft",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "subtotal": {
      "amount": 999,
      "currency": "USD"
    },
    "tax": {
      "amount": 999,
      "currency": "USD"
    },
    "taxExemptionReason": "calculationFailed",
    "total": {
      "amount": 999,
      "currency": "USD"
    },
    "createdAt": "2024-01-09T15:00:51Z",
    "finalizedAt": "2024-02-01T11:12:13Z",
    "paidAt": "2024-02-01T11:13:13Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.invoice.created",
  "version": "2024-10-28"
}