com.gigs.order.updated

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
required
Description
Name
object
Type
string
required
Description
Type of object is always order.
Name
id
Type
string
required
Description
Unique identifier for the order.
Example: ord_0SNlurA049MEWV0SiRFOw0dmChqN
Name
addons
Type
array
required
Description
List of add-ons that are part of the order, if any.
Name
discount
Type
object
required
Description
The total discount applied to this order.
Name
lastPayment
Type
nullable object
required
Description
State of the latest payment attempt for a `subscription` or `order`.
Name
plan
Type
nullable object
required
Description
Plan that is part of the order, if any.
Name
price
Type
object
required
Description
Name
status
Type
string
required
Description
The current status of the order. Every order starts in status pending and can transition to the final states completed or canceled. A possible intermediate status is paid.
Allowed values: canceled, completed, paid, pending, quoted
Name
subscription
Type
nullable string
required
Description
The unique identifier for the subscription that the order applies to, if any. Orders for new plans will not have a subscription until they are confirmed.
Example: sub_0SNlurA049MEWV2gSfSxi00xlPIi
Name
subscriptionAddons
Type
array
required
Description
List of unique identifiers for the subscription add-ons that the order applies to, if any.
Name
subscriptionDetails
Type
nullable object
required
Description
The details of the subscription that will be created as result of this order. Present for quoted orders for new plans.
Name
subtotal
Type
object
required
Description
The total amount to be paid before any applied discounts and taxes.
Name
taxes
Type
array
PREVIEW
required
Description
List of taxes applied, aggregated by tax.
Name
user
Type
object
required
Description
User the order belongs to.
Name
voucher
Type
nullable object
required
Description
Voucher applied to the order, if any.
Name
createdAt
Type
string
required
Description
Time when the order was created.
Example: 2021-01-21T19:38:34Z
Name
datacontenttype
Type
string
required
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).
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.order.updated.
Name
version
Type
string
required
Description
API version used to serialize the data and the event itself.
Default: 2024-08-29

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "order",
    "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN",
    "discount": {
      "amount": 999,
      "currency": "USD"
    },
    "lastPayment": {
      "object": "payment",
      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
      "amount": {
        "amount": 999,
        "currency": "USD"
      },
      "discount": {
        "amount": 999,
        "currency": "USD"
      },
      "failedAttempts": 3,
      "failureCode": "paymentCardDeclined",
      "failureMessage": "The card has been declined.",
      "invoiceNumber": "B74BDB55-0555",
      "method": {
        "object": "paymentMethod",
        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
        "brand": "visa",
        "last4": "4242",
        "provider": "stripe",
        "status": "available",
        "type": "card",
        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
        "createdAt": "2021-02-14T19:38:34Z"
      },
      "reason": "subscriptionCreation",
      "receipt": "https://files.gigs.com/receipts/pay_0SNlurA049MEWV2HRA0slWFuS8DV.pdf",
      "refunded": {
        "amount": 999,
        "currency": "USD"
      },
      "status": "succeeded",
      "subtotal": {
        "amount": 999,
        "currency": "USD"
      },
      "taxes": [
        {
          "object": "tax",
          "inclusive": false,
          "name": "State Sales Tax",
          "value": {
            "amount": 90,
            "currency": "USD"
          }
        }
      ],
      "total": {
        "amount": 999,
        "currency": "USD"
      },
      "user": {
        "object": "user",
        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
        "birthday": "2017-07-21",
        "email": "jerry@example.com",
        "emailVerified": true,
        "fullName": "Jerry Seinfeld",
        "preferredLocale": "en-US",
        "createdAt": "2021-01-21T19:38:34Z"
      },
      "voucher": {
        "object": "voucher",
        "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
        "name": "Monthly Basic 15%",
        "priceDiscount": {
          "amount": 999,
          "currency": "USD"
        },
        "priceDiscountPercentage": 30.12,
        "recurrence": {
          "type": "once"
        },
        "redemptions": 2,
        "restrictions": {
          "expiresAt": "2021-04-14T19:38:34Z"
        },
        "status": "available",
        "createdAt": "2021-02-14T19:38:34Z"
      },
      "voucherCode": {
        "object": "voucherCode",
        "id": "voc_0SNlurA049MEWV0Q5vaTJnKoXc1v",
        "code": "BlackFriday22",
        "redemptions": 2,
        "restrictions": {
          "firstTimeTransaction": true,
          "minimumPrice": {
            "amount": 999,
            "currency": "USD"
          },
          "expiresAt": "2021-04-14T19:38:34Z"
        },
        "status": "active",
        "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
        "createdAt": "2021-02-14T19:38:34Z"
      },
      "attemptedAt": "2021-02-14T19:38:34Z",
      "createdAt": "2021-02-14T19:38:34Z",
      "disputeClosedAt": "2021-02-14T19:38:34Z",
      "refundedAt": "2021-02-14T19:38:34Z"
    },
    "plan": {
      "object": "plan",
      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
      "allowances": {
        "dataBytes": 10000000000,
        "voiceSeconds": 30000,
        "smsMessages": 100
      },
      "coverage": {
        "object": "coverage",
        "id": "de",
        "countries": [
          "DE",
          "FR",
          "US"
        ],
        "name": "Europe"
      },
      "data": 10000000000,
      "dataUnit": "byte",
      "description": "A data plan you will love! Operates in most countries of the world.",
      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
      "limits": {
        "dataBytes": 100000000000,
        "throttling": {
          "thresholdBytes": 10000000000,
          "bandwidthBitsPerSecond": 512000
        }
      },
      "name": "Gigs Global",
      "price": {
        "amount": 999,
        "currency": "USD"
      },
      "provider": "p5",
      "requirements": {
        "address": "present",
        "device": "none",
        "user.birthday": "none",
        "user.fullName": "present"
      },
      "simTypes": [
        "eSIM",
        "pSIM"
      ],
      "sms": 100,
      "smsUnit": "message",
      "status": "available",
      "validity": {
        "minimumPeriods": 12,
        "type": "recurring",
        "unit": "day",
        "value": 7
      },
      "voice": 30000,
      "voiceUnit": "second",
      "createdAt": "2021-01-21T19:38:34Z"
    },
    "price": {
      "amount": 999,
      "currency": "USD"
    },
    "status": "canceled",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "subscriptionDetails": {
      "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
      "device": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
      "deviceModel": "dmd_0SNlurA04OUskUGfGAn3Rh",
      "porting": "prt_0SNlurA049MEWV39s2kSYqaat7ZS"
    },
    "subtotal": {
      "amount": 999,
      "currency": "USD"
    },
    "user": {
      "object": "user",
      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
      "birthday": "2017-07-21",
      "email": "jerry@example.com",
      "emailVerified": true,
      "fullName": "Jerry Seinfeld",
      "preferredLocale": "en-US",
      "createdAt": "2021-01-21T19:38:34Z"
    },
    "voucher": {
      "object": "voucher",
      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
      "name": "Monthly Basic 15%",
      "priceDiscount": {
        "amount": 999,
        "currency": "USD"
      },
      "priceDiscountPercentage": 30.12,
      "recurrence": {
        "type": "once"
      },
      "redemptions": 2,
      "restrictions": {
        "expiresAt": "2021-04-14T19:38:34Z"
      },
      "status": "available",
      "createdAt": "2021-02-14T19:38:34Z"
    },
    "createdAt": "2021-01-21T19:38:34Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.order.updated",
  "version": "2024-08-29"
}