{
  "openapi": "3.1.0",
  "info": {
    "title": "Gigs API",
    "description": "Manage subscriptions, plans, users, billing and payments, and receive events about them as webhooks.",
    "contact": {
      "name": "Gigs Support",
      "email": "support@gigs.com"
    },
    "version": "2026-01-29.338"
  },
  "servers": [
    {
      "url": "https://api.gigs.com",
      "description": "production"
    }
  ],
  "paths": {
    "/projects/{project}/addons": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "AddonsList",
        "summary": "List all add-ons",
        "description": "List add-ons. By default only add-ons with a status of 'available' are returned.",
        "parameters": [
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          },
          {
            "name": "coverageCountry",
            "in": "query",
            "description": "The ISO3166 alpha-2 country code to filter the add-ons by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "examples": [
                  "DE"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "provider",
            "in": "query",
            "description": "The provider of the add-on to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "p4"
              ]
            }
          },
          {
            "name": "plan",
            "in": "query",
            "description": "Limit the list of add-ons to those compatible with the given plan id.",
            "schema": {
              "type": "string",
              "examples": [
                "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "The status of the add-on to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "available"
              ]
            }
          },
          {
            "name": "type",
            "in": "query",
            "description": "The type of the add-on to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "topUp"
              ]
            }
          },
          {
            "name": "recurrenceType",
            "in": "query",
            "description": "The recurrence type of the add-on to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "oneTime"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of add-ons.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `addon`.",
                      "items": {
                        "$ref": "#/components/schemas/addon"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "addon",
                          "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "metadata": {},
                          "activationTrigger": "creation",
                          "allowances": {
                            "dataBytes": 10000000000,
                            "voiceSeconds": 30000,
                            "smsMessages": 100
                          },
                          "coverage": {
                            "object": "coverage",
                            "id": "de",
                            "countries": [
                              "DE",
                              "FR",
                              "US"
                            ],
                            "name": "Europe"
                          },
                          "createdAt": "2021-01-21T19:12:28Z",
                          "description": "Disable international roaming.",
                          "limits": {
                            "dataBytes": 13000000000,
                            "throttling": {
                              "thresholdBytes": 3000000000,
                              "bandwidthBitsPerSecond": 256000
                            }
                          },
                          "name": "1GB Data Top-up",
                          "plans": [
                            "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                          ],
                          "price": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "provider": "p5",
                          "recurrenceType": "oneTime",
                          "status": "draft",
                          "type": "topUp",
                          "validity": {
                            "unit": "day",
                            "value": 7,
                            "totalPeriods": 1
                          },
                          "data": 10000000000,
                          "dataUnit": "byte",
                          "sms": 100,
                          "smsUnit": "message",
                          "voice": 30000,
                          "voiceUnit": "second"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "addon",
                          "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "metadata": {},
                          "activationTrigger": "creation",
                          "allowances": {
                            "dataBytes": 10000000000,
                            "voiceSeconds": 30000,
                            "smsMessages": 100
                          },
                          "coverage": {
                            "object": "coverage",
                            "id": "de",
                            "countries": [
                              "DE",
                              "FR",
                              "US"
                            ],
                            "name": "Europe"
                          },
                          "createdAt": "2021-01-21T19:12:28Z",
                          "description": "Disable international roaming.",
                          "limits": {
                            "dataBytes": 13000000000,
                            "throttling": {
                              "thresholdBytes": 3000000000,
                              "bandwidthBitsPerSecond": 256000
                            }
                          },
                          "name": "1GB Data Top-up",
                          "plans": [
                            "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                          ],
                          "price": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "provider": "p5",
                          "recurrenceType": "oneTime",
                          "status": "draft",
                          "type": "topUp",
                          "validity": {
                            "unit": "day",
                            "value": 7
                          },
                          "data": 10000000000,
                          "dataUnit": "byte",
                          "sms": 100,
                          "smsUnit": "message",
                          "voice": 30000,
                          "voiceUnit": "second"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          }
        }
      }
    },
    "/projects/{project}/addons/{addon}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "$ref": "#/components/parameters/addon"
        }
      ],
      "get": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "AddonsRetrieve",
        "summary": "Retrieve an add-on",
        "description": "Retrieves the details of an existing add-on.",
        "responses": {
          "200": {
            "description": "Returns the add-on object if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/addon"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "patch": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "AddonsUpdate",
        "summary": "Update an add-on",
        "description": "Updates an add-on's name and description.",
        "requestBody": {
          "description": "Add-on attributes to update.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The name of the add-on, meant to be displayable to users.",
                    "examples": [
                      "1GB Data Top-up"
                    ]
                  },
                  "description": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The description of the add-on.",
                    "examples": [
                      "Disable international roaming."
                    ]
                  },
                  "validity": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "The custom validity for this add-on. Set to `null` to remove custom validity and fall back to network add-on validity.\n                If provided, must not exceed the network add-on's validity period.",
                    "properties": {
                      "unit": {
                        "type": "string",
                        "enum": [
                          "day",
                          "month"
                        ],
                        "description": "The time unit, either `day` or `month`.",
                        "examples": [
                          "day"
                        ]
                      },
                      "value": {
                        "type": "integer",
                        "description": "The amount of units.",
                        "minimum": 1,
                        "examples": [
                          7
                        ]
                      },
                      "totalPeriods": {
                        "type": "integer",
                        "description": "How many times the validity period repeats. The total lifetime (`value` times `unit` times `totalPeriods`) must not exceed 10 years.",
                        "maximum": 3652,
                        "minimum": 1,
                        "examples": [
                          1
                        ]
                      }
                    },
                    "required": [
                      "unit",
                      "value"
                    ]
                  },
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  }
                },
                "required": []
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "name": "1GB Data Top-up",
                    "description": "Disable international roaming.",
                    "validity": {
                      "unit": "day",
                      "value": 7,
                      "totalPeriods": 1
                    },
                    "metadata": {}
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the updated add-on.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/addon"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/addons/{addon}/archive": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "$ref": "#/components/parameters/addon"
        }
      ],
      "post": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "AddonsArchive",
        "summary": "Archive an add-on",
        "description": "Set the status of an add-on to archived. An archived add-on can not be added to subscriptions.",
        "responses": {
          "200": {
            "description": "Returns the archived add-on.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/addon"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/addons/{addon}/publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "$ref": "#/components/parameters/addon"
        }
      ],
      "post": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "AddonsPublish",
        "summary": "Publish an add-on",
        "description": "Set the status of an add-on to available. Available add-ons can be added to subscriptions.",
        "responses": {
          "200": {
            "description": "Returns the available add-on.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/addon"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/consentRequests": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "ConsentRequestsList",
        "summary": "List all consent requests",
        "description": "Returns a list of consent requests. The consent requests returned are sorted by creation date, with the most recently created consent requests appearing first.",
        "parameters": [
          {
            "name": "subject",
            "in": "query",
            "description": "The unique identifier for the subject related to the consent request.",
            "schema": {
              "type": "string",
              "examples": [
                "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
              ]
            }
          },
          {
            "name": "subscription",
            "in": "query",
            "description": "The unique identifier for the subscription related to the consent request.",
            "schema": {
              "type": "string",
              "examples": [
                "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "A comma-separated list of statuses to filter the consent requests by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "approved",
                  "bypassed",
                  "canceled",
                  "expired",
                  "pending"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a list of consentRequest objects.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `consentRequest`.",
                      "items": {
                        "$ref": "#/components/schemas/consentRequest"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "consentRequest",
                          "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                          "createdAt": "2024-01-09T15:00:51Z",
                          "deliveryMethod": "emailLink",
                          "expiredAt": "2024-01-09T15:00:51Z",
                          "operation": "exchange.sim",
                          "status": "pending",
                          "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "consentRequest",
                          "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                          "createdAt": "2024-01-09T15:00:51Z",
                          "deliveryMethod": "emailLink",
                          "expiredAt": "2024-01-09T15:00:51Z",
                          "operation": "exchange.sim",
                          "status": "pending",
                          "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "post": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "ConsentRequestsCreate",
        "summary": "Create a consent request",
        "description": "Creates a new consent request from an existing one, delivering a new code to the user.\nThe existing consent request must be pending or\nexpired and must be the most recent one for its resource.\nA pending one expires as soon as the new one is created.\n",
        "requestBody": {
          "description": "The consent request to create the new one from.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "title": "ConsentRequestCreate",
                "properties": {
                  "fromConsentRequest": {
                    "type": "string",
                    "description": "The unique identifier for the existing consent request to recreate, e.g. when the user missed the original code. The new consent request covers the same operation and resource and carries a newly generated code. The referenced consent request must be `pending` or `expired` and must be the most recent one for its resource. A `pending` one expires as soon as the new one is created.",
                    "examples": [
                      "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"
                    ]
                  }
                },
                "required": [
                  "fromConsentRequest"
                ]
              },
              "examples": {
                "Example": {
                  "summary": "Example",
                  "value": {
                    "fromConsentRequest": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the created consent request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/consentRequest"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/consentRequests/{consentRequest}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "consentRequest",
          "in": "path",
          "description": "The unique identifier of the consent request.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "ConsentRequestsRetrieve",
        "summary": "Retrieve a consent request",
        "description": "Retrieves a consent request by the given id.\n",
        "responses": {
          "200": {
            "description": "Returns the consent request if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/consentRequest"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/consentRequests/{consentRequest}/approve": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "consentRequest",
          "in": "path",
          "description": "The unique identifier of the consent request.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "ConsentRequestsApprove",
        "summary": "Approves the consent request",
        "description": "Grants consent for the given request. This will trigger the consent\nrequest to be processed and the request to transition to the\napproved status. The consent request must be\nin the pending status in order to be approved.\n",
        "requestBody": {
          "description": "The credentials required to approve the consent request.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "title": "ConsentRequestApprove",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "The OTP associated with the consent request, used to validate the given consent.",
                    "examples": [
                      "123456"
                    ]
                  }
                },
                "required": [
                  "code"
                ]
              },
              "examples": {
                "Example": {
                  "summary": "Example",
                  "value": {
                    "code": "123456"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the consent request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/consentRequest"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/devices": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Devices"
        ],
        "operationId": "DevicesList",
        "summary": "List all devices",
        "description": "Returns a list of devices. The devices returned are sorted by creation date, with the most recently created devices appearing first.",
        "parameters": [
          {
            "name": "sim",
            "in": "query",
            "description": "The unique identifier for the sim to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
              ]
            }
          },
          {
            "name": "user",
            "in": "query",
            "description": "The unique identifier for the user to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of devices.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `device`.",
                      "items": {
                        "$ref": "#/components/schemas/device"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "device",
                          "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                          "metadata": {},
                          "createdAt": "2021-02-14T19:38:34Z",
                          "imei": "492388841798923",
                          "model": {
                            "object": "deviceModel",
                            "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                            "brand": "Apple",
                            "hardwareIdentifiers": [
                              "SM-S928U1"
                            ],
                            "name": "iPhone 12 Pro",
                            "simTypes": [
                              "eSIM",
                              "pSIM"
                            ],
                            "type": "smartphone"
                          },
                          "name": "Anna's iPhone 12 Pro",
                          "sims": [
                            {
                              "object": "sim",
                              "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                              "metadata": {},
                              "createdAt": "2021-01-21T19:38:34Z",
                              "iccid": "89883070000007537119",
                              "provider": "p9",
                              "status": "inactive",
                              "suspension": null,
                              "type": "eSIM"
                            }
                          ],
                          "user": {
                            "object": "user",
                            "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                            "metadata": {},
                            "birthday": "2017-07-21",
                            "createdAt": "2021-01-21T19:38:34Z",
                            "email": "jerry@example.com",
                            "emailVerified": true,
                            "fullName": "Jerry Seinfeld",
                            "preferredLocale": "en-US",
                            "status": "active"
                          }
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "device",
                          "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                          "metadata": {},
                          "createdAt": "2021-02-14T19:38:34Z",
                          "imei": "492388841798923",
                          "model": {
                            "object": "deviceModel",
                            "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                            "brand": "Apple",
                            "hardwareIdentifiers": [
                              "SM-S928U1"
                            ],
                            "name": "iPhone 12 Pro",
                            "simTypes": [
                              "eSIM",
                              "pSIM"
                            ],
                            "type": "smartphone"
                          },
                          "name": "Anna's iPhone 12 Pro",
                          "sims": [
                            {
                              "object": "sim",
                              "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                              "metadata": {},
                              "createdAt": "2021-01-21T19:38:34Z",
                              "iccid": "89883070000007537119",
                              "provider": "p9",
                              "status": "inactive",
                              "suspension": null,
                              "type": "eSIM"
                            }
                          ],
                          "user": {
                            "object": "user",
                            "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                            "metadata": {},
                            "birthday": "2017-07-21",
                            "createdAt": "2021-01-21T19:38:34Z",
                            "email": "jerry@example.com",
                            "emailVerified": true,
                            "fullName": "Jerry Seinfeld",
                            "preferredLocale": "en-US",
                            "status": "active"
                          }
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "post": {
        "tags": [
          "Devices"
        ],
        "operationId": "DevicesCreate",
        "summary": "Create a device",
        "description": "Creates a new device with the given parameters.",
        "requestBody": {
          "description": "Device attributes to create. You must specify either an IMEI or a user.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "imei": {
                    "type": "string",
                    "pattern": "^[0-9]{15,16}$",
                    "description": "The IMEI (international mobile equipment identity) of the device.",
                    "examples": [
                      "492388841798923"
                    ]
                  },
                  "user": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "Unique user identifier for the device owner.",
                    "examples": [
                      "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    ]
                  },
                  "sims": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "description": "List of identifiers for all SIMs to attach to the device.",
                    "items": {
                      "type": "string",
                      "description": "Unique SIM identifier.",
                      "examples": [
                        "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                      ]
                    }
                  },
                  "name": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "An optional custom name for the device.",
                    "examples": [
                      "Anna's iPhone 12 Pro"
                    ]
                  },
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  }
                },
                "required": [
                  "imei"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "imei": "492388841798923",
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                    "sims": [
                      "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                    ],
                    "name": "Anna's iPhone 12 Pro",
                    "metadata": {}
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "imei": "492388841798923"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the created device.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/device"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/devices/{device}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "device",
          "in": "path",
          "description": "The unique identifier for the device.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "dev_0SNlurA049MEWV55CrA9qMvI2FVJ"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Devices"
        ],
        "operationId": "DevicesRetrieve",
        "summary": "Retrieve a device",
        "description": "Retrieves the details of an existing device owned by the authenticated user.",
        "responses": {
          "200": {
            "description": "Returns the device object if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/device"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "delete": {
        "tags": [
          "Devices"
        ],
        "operationId": "DevicesDelete",
        "summary": "Delete a device",
        "description": "Retrieves the details of an existing device and deletes it.",
        "responses": {
          "200": {
            "description": "Returns the device after a successful deletion.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/device"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "patch": {
        "tags": [
          "Devices"
        ],
        "operationId": "DevicesUpdate",
        "summary": "Update a device",
        "description": "Updates the given properties of an existing device.",
        "requestBody": {
          "description": "The device properties to update, at least one of them must be provided. Use null or an empty array to remove existing values.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "An optional custom name for the device.",
                    "examples": [
                      "Anna's iPhone 12 Pro"
                    ]
                  },
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  },
                  "sims": {
                    "type": "array",
                    "description": "List of identifiers for all SIMs currently attached to the device.",
                    "items": {
                      "type": "string",
                      "description": "Unique SIM identifier.",
                      "examples": [
                        "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                      ]
                    }
                  },
                  "user": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "Unique user identifier for the device owner.",
                    "examples": [
                      "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    ]
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "name": "Anna's iPhone 12 Pro",
                    "metadata": {},
                    "sims": [
                      "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                    ],
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the updated device object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/device"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/devices/search": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "Devices"
        ],
        "operationId": "DevicesSearch",
        "summary": "Search for devices",
        "description": "Searches for existing devices matching the given parameters. The search will only return factory devices not yet assigned to any user, or devices already owned by the current user.",
        "requestBody": {
          "description": "Device attributes to search for.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "imei": {
                    "type": "string",
                    "pattern": "^[0-9]{15,16}$",
                    "description": "The IMEI (international mobile equipment identity) of the device.",
                    "examples": [
                      "492388841798923"
                    ]
                  }
                },
                "required": [
                  "imei"
                ]
              },
              "examples": {
                "Example": {
                  "summary": "Example",
                  "value": {
                    "imei": "492388841798923"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns a list schema response with all found devices.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `device`.",
                      "items": {
                        "$ref": "#/components/schemas/device"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "device",
                          "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                          "metadata": {},
                          "createdAt": "2021-02-14T19:38:34Z",
                          "imei": "492388841798923",
                          "model": {
                            "object": "deviceModel",
                            "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                            "brand": "Apple",
                            "hardwareIdentifiers": [
                              "SM-S928U1"
                            ],
                            "name": "iPhone 12 Pro",
                            "simTypes": [
                              "eSIM",
                              "pSIM"
                            ],
                            "type": "smartphone"
                          },
                          "name": "Anna's iPhone 12 Pro",
                          "sims": [
                            {
                              "object": "sim",
                              "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                              "metadata": {},
                              "createdAt": "2021-01-21T19:38:34Z",
                              "iccid": "89883070000007537119",
                              "provider": "p9",
                              "status": "inactive",
                              "suspension": null,
                              "type": "eSIM"
                            }
                          ],
                          "user": {
                            "object": "user",
                            "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                            "metadata": {},
                            "birthday": "2017-07-21",
                            "createdAt": "2021-01-21T19:38:34Z",
                            "email": "jerry@example.com",
                            "emailVerified": true,
                            "fullName": "Jerry Seinfeld",
                            "preferredLocale": "en-US",
                            "status": "active"
                          }
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "device",
                          "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                          "metadata": {},
                          "createdAt": "2021-02-14T19:38:34Z",
                          "imei": "492388841798923",
                          "model": {
                            "object": "deviceModel",
                            "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                            "brand": "Apple",
                            "hardwareIdentifiers": [
                              "SM-S928U1"
                            ],
                            "name": "iPhone 12 Pro",
                            "simTypes": [
                              "eSIM",
                              "pSIM"
                            ],
                            "type": "smartphone"
                          },
                          "name": "Anna's iPhone 12 Pro",
                          "sims": [
                            {
                              "object": "sim",
                              "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                              "metadata": {},
                              "createdAt": "2021-01-21T19:38:34Z",
                              "iccid": "89883070000007537119",
                              "provider": "p9",
                              "status": "inactive",
                              "suspension": null,
                              "type": "eSIM"
                            }
                          ],
                          "user": {
                            "object": "user",
                            "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                            "metadata": {},
                            "birthday": "2017-07-21",
                            "createdAt": "2021-01-21T19:38:34Z",
                            "email": "jerry@example.com",
                            "emailVerified": true,
                            "fullName": "Jerry Seinfeld",
                            "preferredLocale": "en-US",
                            "status": "active"
                          }
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/deviceModelBrands": {
      "get": {
        "tags": [
          "Devices"
        ],
        "operationId": "DeviceModelBrandsList",
        "summary": "List all device model brands",
        "description": "Returns a list of device model brands. The device model brands returned are sorted alphabetically.",
        "responses": {
          "200": {
            "description": "Returns a list of device model brands.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deviceModelBrands"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "deviceModelBrands",
                      "items": [
                        "Apple"
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/deviceModels/{deviceModel}": {
      "parameters": [
        {
          "name": "deviceModel",
          "in": "path",
          "description": "The unique identifier for the device model.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "dmd_0SNlurA04OUskUGfGAn3Rh"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Devices"
        ],
        "operationId": "DeviceModelsRetrieve",
        "summary": "Retrieve a device model",
        "description": "Retrieves the details of an existing device model.",
        "responses": {
          "200": {
            "description": "Returns the device model object if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deviceModel"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "deviceModel",
                      "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                      "brand": "Apple",
                      "hardwareIdentifiers": [
                        "SM-S928U1"
                      ],
                      "name": "iPhone 12 Pro",
                      "simTypes": [
                        "eSIM",
                        "pSIM"
                      ],
                      "type": "smartphone"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/deviceModels/search": {
      "post": {
        "tags": [
          "Devices"
        ],
        "operationId": "DeviceModelsSearch",
        "summary": "Search for device models",
        "description": "Searches for existing devices models matching the given parameters.",
        "requestBody": {
          "description": "Device model attributes to search for.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "imei": {
                    "type": "string",
                    "pattern": "^[0-9]{15,16}$",
                    "description": "The IMEI (international mobile equipment identity) of the corresponding device.",
                    "examples": [
                      "492388841798923"
                    ]
                  }
                },
                "required": [
                  "imei"
                ]
              },
              "examples": {
                "Example": {
                  "summary": "Example",
                  "value": {
                    "imei": "492388841798923"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns a list schema response with all found device models.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `deviceModel`.",
                      "items": {
                        "$ref": "#/components/schemas/deviceModel"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "deviceModel",
                          "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                          "brand": "Apple",
                          "hardwareIdentifiers": [
                            "SM-S928U1"
                          ],
                          "name": "iPhone 12 Pro",
                          "simTypes": [
                            "eSIM",
                            "pSIM"
                          ],
                          "type": "smartphone"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "deviceModel",
                          "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                          "brand": "Apple",
                          "hardwareIdentifiers": [
                            "SM-S928U1"
                          ],
                          "name": "iPhone 12 Pro",
                          "simTypes": [
                            "eSIM",
                            "pSIM"
                          ],
                          "type": "smartphone"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/deviceModels": {
      "get": {
        "tags": [
          "Devices"
        ],
        "operationId": "DeviceModelsList",
        "summary": "List all device models",
        "description": "Returns a list of device models. The models returned are sorted by creation date, with the most recently created models appearing first.",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "description": "A comma-separated list of types to be filtered by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "car",
                  "iot",
                  "laptop",
                  "router",
                  "smartphone",
                  "feature-phone",
                  "smartwatch",
                  "tablet",
                  "wearable",
                  "other"
                ]
              },
              "examples": [
                "smartphone,tablet"
              ]
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "brand",
            "in": "query",
            "description": "A comma-separated list of brands to be filtered by. To include a literal comma in a value, double-encode it as `%252C`.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "examples": [
                "Apple,Samsung"
              ]
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "simType",
            "in": "query",
            "description": "A comma-separated list of SIM types to be filtered by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "eSIM",
                  "pSIM"
                ]
              },
              "examples": [
                "eSIM,pSIM"
              ]
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "hardwareIdentifier",
            "in": "query",
            "description": "A comma-separated list of hardware identifiers (e.g. the Android `Build.MODEL` string) to filter device models by. To include a literal comma in a value, double-encode it as `%252C`.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "examples": [
                "SM-S928U1,SM-S928U2"
              ]
            },
            "style": "form",
            "explode": false
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of device models.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `deviceModel`.",
                      "items": {
                        "$ref": "#/components/schemas/deviceModel"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "deviceModel",
                          "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                          "brand": "Apple",
                          "hardwareIdentifiers": [
                            "SM-S928U1"
                          ],
                          "name": "iPhone 12 Pro",
                          "simTypes": [
                            "eSIM",
                            "pSIM"
                          ],
                          "type": "smartphone"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "deviceModel",
                          "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                          "brand": "Apple",
                          "hardwareIdentifiers": [
                            "SM-S928U1"
                          ],
                          "name": "iPhone 12 Pro",
                          "simTypes": [
                            "eSIM",
                            "pSIM"
                          ],
                          "type": "smartphone"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/sims/{sim}/eSimProfile": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "sim",
          "in": "path",
          "description": "The unique identifier for the SIM.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "SIMs"
        ],
        "operationId": "EsimProfilesRetrieve",
        "summary": "Retrieve an eSIM profile",
        "description": "Retrieves the details of an existing eSIM profile for a given SIM.\n\nA 404 response will be returned if the SIM does not exist, or is a pSIM.\n\nNote that for providers other than `p3`, `p14` or `p15` the `status` of\nthe profile will currently always be `unknown`.\n\nRelated guide: [eSIM profile lifecycle](https://developers.gigs.com/docs/core/sims#e-sim-profile-lifecycle)\n",
        "responses": {
          "200": {
            "description": "Returns the eSimProfile if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/eSimProfile"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/networkAvailability/lookup": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "Network Availabilities"
        ],
        "operationId": "NetworkAvailabilitiesLookup",
        "summary": "Lookup network availability by location",
        "description": "Looks up network availability information based on geographic coordinates (latitude/longitude) or address. Returns network availability data only for US locations.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "description": "Location to lookup availability for. Provide either `coordinates` or `address`.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "address": {
                    "type": "object",
                    "title": "NetworkAvailabilityAddress",
                    "description": "The address for which availability information is provided.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This schema is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "properties": {
                      "city": {
                        "type": "string",
                        "description": "The city/municipality of the address.",
                        "examples": [
                          "New York City"
                        ]
                      },
                      "country": {
                        "type": "string",
                        "description": "The ISO 3166-1 alpha-2 country code of the address.",
                        "examples": [
                          "US"
                        ]
                      },
                      "line1": {
                        "type": "string",
                        "description": "The first line of the address, e.g. street and house number.",
                        "examples": [
                          "129 West 81st Street"
                        ]
                      },
                      "line2": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The second line of the address, e.g. apartment number.",
                        "examples": [
                          "Apartment 5"
                        ]
                      },
                      "postalCode": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The postal code of the address.",
                        "examples": [
                          "10024"
                        ]
                      },
                      "state": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The state/province/region of the address.",
                        "examples": [
                          "NY"
                        ]
                      }
                    },
                    "required": [
                      "city",
                      "country",
                      "line1"
                    ]
                  },
                  "coordinates": {
                    "type": "object",
                    "title": "NetworkAvailabilityCoordinates",
                    "description": "The coordinates for which availability information is provided.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This schema is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "properties": {
                      "latitude": {
                        "type": "number",
                        "description": "The latitude coordinate for which availability information is provided.",
                        "maximum": 90,
                        "minimum": -90,
                        "examples": [
                          40.7831
                        ]
                      },
                      "longitude": {
                        "type": "number",
                        "description": "The longitude coordinate for which availability information is provided.",
                        "maximum": 180,
                        "minimum": -180,
                        "examples": [
                          -73.9712
                        ]
                      }
                    },
                    "required": [
                      "latitude",
                      "longitude"
                    ]
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "address": {
                      "city": "New York City",
                      "country": "US",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY"
                    },
                    "coordinates": {
                      "latitude": 40.7831,
                      "longitude": -73.9712
                    }
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "description": "Returns the network availability data with location.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/networkAvailability"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "networkAvailability",
                      "availability": [
                        {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "provider": "p11",
                          "technologies": {
                            "4G": {
                              "strength": "good",
                              "minDecibelMilliwatts": -90.0
                            },
                            "5G": {
                              "strength": "fair",
                              "minDecibelMilliwatts": -100.0
                            }
                          }
                        }
                      ],
                      "location": {
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "coordinates": {
                          "latitude": 40.7831,
                          "longitude": -73.9712
                        }
                      }
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "networkAvailability",
                      "availability": [
                        {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "provider": "p11",
                          "technologies": {
                            "4G": {
                              "strength": "good",
                              "minDecibelMilliwatts": -90.0
                            },
                            "5G": {
                              "strength": "fair",
                              "minDecibelMilliwatts": -100.0
                            }
                          }
                        }
                      ],
                      "location": {}
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/networkAvailabilityTilesets": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Network Availabilities"
        ],
        "operationId": "NetworkAvailabilityTilesetsList",
        "summary": "List all coverage map tilesets",
        "description": "Returns the tilesets needed to render a coverage map, based on the project's available plans.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          },
          {
            "name": "plan",
            "in": "query",
            "description": "Returns the tileset for a specific plan, if available.",
            "schema": {
              "type": "string",
              "examples": [
                "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a list of network availability tilesets.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `networkAvailabilityTileset`.",
                      "items": {
                        "$ref": "#/components/schemas/networkAvailabilityTileset"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "networkAvailabilityTileset",
                          "expiresAt": "2026-08-04T12:00:00Z",
                          "layers": [
                            {
                              "technology": "5G",
                              "sourceLayer": "coverage_5g"
                            }
                          ],
                          "maxZoom": 10,
                          "minZoom": 0,
                          "urlTemplate": "https://tiles.gigs.com/tiles/default/2026-08-03/{z}/{x}/{y}.pbf?URLPrefix=aHR0cHM6Ly90aWxlcy5naWdzLmNvbS90aWxlcy9kZWZhdWx0LzIwMjYtMDgtMDMv&Expires=1785844800&KeyName=tiles-key-20260930&Signature=pciE55nCNX-qhXzJNSAXaf34624="
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "networkAvailabilityTileset",
                          "expiresAt": "2026-08-04T12:00:00Z",
                          "layers": [
                            {
                              "technology": "5G",
                              "sourceLayer": "coverage_5g"
                            }
                          ],
                          "maxZoom": 10,
                          "minZoom": 0,
                          "urlTemplate": "https://tiles.gigs.com/tiles/default/2026-08-03/{z}/{x}/{y}.pbf?URLPrefix=aHR0cHM6Ly90aWxlcy5naWdzLmNvbS90aWxlcy9kZWZhdWx0LzIwMjYtMDgtMDMv&Expires=1785844800&KeyName=tiles-key-20260930&Signature=pciE55nCNX-qhXzJNSAXaf34624="
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/plans": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Plans"
        ],
        "operationId": "PlansList",
        "summary": "List all plans",
        "description": "Returns a list of plans.",
        "parameters": [
          {
            "name": "provider",
            "in": "query",
            "description": "The network provider ID to filter the plans by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "examples": [
                  "p3"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "simType",
            "in": "query",
            "description": "The type of SIM card to filter the plans by.",
            "schema": {
              "type": "array",
              "default": [
                "eSIM",
                "pSIM"
              ],
              "items": {
                "type": "string",
                "enum": [
                  "eSIM",
                  "pSIM"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "status",
            "in": "query",
            "description": "The status to filter the plans by. Only available plans are returned by default.",
            "schema": {
              "type": "array",
              "default": [
                "available"
              ],
              "items": {
                "type": "string",
                "enum": [
                  "available",
                  "archived",
                  "pending",
                  "draft"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "coverageCountry",
            "in": "query",
            "description": "The ISO3166 alpha-2 country code to filter the plans by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "examples": [
                  "DE"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a list of plan objects.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `plan`.",
                      "items": {
                        "$ref": "#/components/schemas/plan"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "plan",
                          "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "metadata": {},
                          "activationTrigger": "creation",
                          "allowances": {
                            "dataBytes": 10000000000,
                            "voiceSeconds": 30000,
                            "smsMessages": 100
                          },
                          "coverage": {
                            "object": "coverage",
                            "id": "de",
                            "countries": [
                              "DE",
                              "FR",
                              "US"
                            ],
                            "name": "Europe"
                          },
                          "createdAt": "2021-01-21T19:38:34Z",
                          "description": "A data plan you will love! Operates in most countries of the world.",
                          "firstPeriodTrigger": "creation",
                          "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                          "limits": {
                            "dataBytes": 100000000000,
                            "bandwidthBitsPerSecond": 100000000,
                            "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"
                          ],
                          "status": "available",
                          "validity": {
                            "minimumPeriods": 12,
                            "type": "recurring",
                            "unit": "day",
                            "value": 7
                          },
                          "data": 10000000000,
                          "dataUnit": "byte",
                          "sms": 100,
                          "smsUnit": "message",
                          "voice": 30000,
                          "voiceUnit": "second"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "plan",
                          "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "metadata": {},
                          "activationTrigger": "creation",
                          "allowances": {
                            "dataBytes": 10000000000,
                            "voiceSeconds": 30000,
                            "smsMessages": 100
                          },
                          "coverage": {
                            "object": "coverage",
                            "id": "de",
                            "countries": [
                              "DE",
                              "FR",
                              "US"
                            ],
                            "name": "Europe"
                          },
                          "createdAt": "2021-01-21T19:38:34Z",
                          "description": "A data plan you will love! Operates in most countries of the world.",
                          "firstPeriodTrigger": "creation",
                          "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                          "limits": {
                            "dataBytes": 100000000000,
                            "bandwidthBitsPerSecond": 100000000,
                            "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"
                          ],
                          "status": "available",
                          "validity": {
                            "minimumPeriods": 12,
                            "type": "recurring",
                            "unit": "day",
                            "value": 7
                          },
                          "data": 10000000000,
                          "dataUnit": "byte",
                          "sms": 100,
                          "smsUnit": "message",
                          "voice": 30000,
                          "voiceUnit": "second"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/plans/{plan}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "$ref": "#/components/parameters/plan"
        }
      ],
      "get": {
        "tags": [
          "Plans"
        ],
        "operationId": "PlansRetrieve",
        "summary": "Retrieve a plan",
        "description": "Retrieve the details of an existing plan.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Returns the plan if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/plan"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "501": {
            "$ref": "#/components/responses/notImplemented"
          }
        }
      },
      "patch": {
        "tags": [
          "Plans"
        ],
        "operationId": "PlansUpdate",
        "summary": "Update a plan",
        "description": "Updates the specified plan by setting the values of the parameters passed.",
        "requestBody": {
          "description": "Plan attributes to update.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "The plan's name, meant to be displayable to the user.",
                    "examples": [
                      "Gigs Global"
                    ]
                  },
                  "description": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The plan's description, meant to be displayable to the user.",
                    "examples": [
                      "A data plan you will love! Operates in most countries of the world."
                    ]
                  },
                  "image": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "url",
                    "description": "The plan's image, meant to be displayable to the user.",
                    "examples": [
                      "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png"
                    ]
                  },
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  }
                },
                "required": []
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "name": "Gigs Global",
                    "description": "A data plan you will love! Operates in most countries of the world.",
                    "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                    "metadata": {}
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the updated plan.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/plan"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/plans/{plan}/archive": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "$ref": "#/components/parameters/plan"
        }
      ],
      "post": {
        "tags": [
          "Plans"
        ],
        "operationId": "PlansArchive",
        "summary": "Archive a plan",
        "description": "Set the status of a plan to archived. An archived plan can not be used to create new subscriptions.",
        "responses": {
          "200": {
            "description": "Returns the archived plan.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/plan"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/plans/{plan}/publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "$ref": "#/components/parameters/plan"
        }
      ],
      "post": {
        "tags": [
          "Plans"
        ],
        "operationId": "PlansPublish",
        "summary": "Publish a plan",
        "description": "Set the status of a plan to available. Available plans can be used to create new subscriptions.",
        "responses": {
          "200": {
            "description": "Returns the available plan.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/plan"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/plans/search": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "Plans"
        ],
        "operationId": "PlansSearch",
        "summary": "Search for Plans",
        "description": "Searches for plans matching the given parameters.",
        "requestBody": {
          "description": "Attributes to search for.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "status": {
                    "type": "array",
                    "default": [
                      "available"
                    ],
                    "description": "The status to filter plans by.",
                    "items": {
                      "type": "string",
                      "enum": [
                        "available",
                        "archived",
                        "pending",
                        "draft"
                      ]
                    }
                  },
                  "simType": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "description": "The type of the SIM card to filter the plans by.",
                    "items": {
                      "type": "string",
                      "enum": [
                        "eSIM",
                        "pSIM"
                      ]
                    }
                  },
                  "provider": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "description": "The network provider ID to filter the plans by.",
                    "items": {
                      "type": "string"
                    },
                    "examples": [
                      [
                        "p3",
                        "p9"
                      ]
                    ]
                  },
                  "coverageCountry": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "description": "The ISO3166 alpha-2 country code to filter the plans by.",
                    "items": {
                      "type": "string"
                    },
                    "examples": [
                      [
                        "DE",
                        "GB"
                      ]
                    ]
                  },
                  "compatibleWith": {
                    "type": "object",
                    "description": "Compatibility requirements for the plans. Only plans compatible with all requirements are returned. At least one requirement must be specified.",
                    "properties": {
                      "imei": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^[0-9]{15,16}$",
                        "description": "The IMEI (international mobile equipment identity) of the corresponding device.",
                        "examples": [
                          "492388841798923"
                        ]
                      },
                      "deviceModel": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The device model identifier of the corresponding device.",
                        "examples": [
                          "dmd_123"
                        ]
                      },
                      "subscription": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Unique identifier for the subscription.",
                        "examples": [
                          "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        ]
                      }
                    }
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "status": [
                      "available"
                    ],
                    "simType": [
                      "eSIM"
                    ],
                    "provider": [
                      "p3",
                      "p9"
                    ],
                    "coverageCountry": [
                      "DE",
                      "GB"
                    ],
                    "compatibleWith": {
                      "imei": "492388841798923",
                      "deviceModel": "dmd_123",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns a list schema response with all found Plans.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `plan`.",
                      "items": {
                        "$ref": "#/components/schemas/plan"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "plan",
                          "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "metadata": {},
                          "activationTrigger": "creation",
                          "allowances": {
                            "dataBytes": 10000000000,
                            "voiceSeconds": 30000,
                            "smsMessages": 100
                          },
                          "coverage": {
                            "object": "coverage",
                            "id": "de",
                            "countries": [
                              "DE",
                              "FR",
                              "US"
                            ],
                            "name": "Europe"
                          },
                          "createdAt": "2021-01-21T19:38:34Z",
                          "description": "A data plan you will love! Operates in most countries of the world.",
                          "firstPeriodTrigger": "creation",
                          "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                          "limits": {
                            "dataBytes": 100000000000,
                            "bandwidthBitsPerSecond": 100000000,
                            "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"
                          ],
                          "status": "available",
                          "validity": {
                            "minimumPeriods": 12,
                            "type": "recurring",
                            "unit": "day",
                            "value": 7
                          },
                          "data": 10000000000,
                          "dataUnit": "byte",
                          "sms": 100,
                          "smsUnit": "message",
                          "voice": 30000,
                          "voiceUnit": "second"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "plan",
                          "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "metadata": {},
                          "activationTrigger": "creation",
                          "allowances": {
                            "dataBytes": 10000000000,
                            "voiceSeconds": 30000,
                            "smsMessages": 100
                          },
                          "coverage": {
                            "object": "coverage",
                            "id": "de",
                            "countries": [
                              "DE",
                              "FR",
                              "US"
                            ],
                            "name": "Europe"
                          },
                          "createdAt": "2021-01-21T19:38:34Z",
                          "description": "A data plan you will love! Operates in most countries of the world.",
                          "firstPeriodTrigger": "creation",
                          "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                          "limits": {
                            "dataBytes": 100000000000,
                            "bandwidthBitsPerSecond": 100000000,
                            "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"
                          ],
                          "status": "available",
                          "validity": {
                            "minimumPeriods": 12,
                            "type": "recurring",
                            "unit": "day",
                            "value": 7
                          },
                          "data": 10000000000,
                          "dataUnit": "byte",
                          "sms": 100,
                          "smsUnit": "message",
                          "voice": 30000,
                          "voiceUnit": "second"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          },
          "503": {
            "$ref": "#/components/responses/serviceUnavailable"
          }
        }
      }
    },
    "/projects/{project}/planDocuments": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Plans"
        ],
        "operationId": "PlanDocumentsList",
        "summary": "List all plan documents",
        "description": "Returns a list of documents related to the given plan. The documents returned are sorted by creation date, with the most recently created documents appearing first.",
        "parameters": [
          {
            "name": "plan",
            "in": "query",
            "description": "The unique identifier for the plan to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a list of document objects.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `planDocument`.",
                      "items": {
                        "$ref": "#/components/schemas/planDocument"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "planDocument",
                          "id": "pdc_0SNlurA049MEWV1S6e1qVqBV2xge",
                          "createdAt": "2022-07-04T16:20:27Z",
                          "language": "en-US",
                          "name": "My Plan Contract",
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "type": "application/pdf",
                          "url": "https://a.gigscdn.net/p/my-project/01G74ZPB5PQTDESM4JGYR2CWB9.pdf"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "planDocument",
                          "id": "pdc_0SNlurA049MEWV1S6e1qVqBV2xge",
                          "createdAt": "2022-07-04T16:20:27Z",
                          "language": "en-US",
                          "name": "My Plan Contract",
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "type": "application/pdf",
                          "url": "https://a.gigscdn.net/p/my-project/01G74ZPB5PQTDESM4JGYR2CWB9.pdf"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/planDocuments/{planDocument}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "planDocument",
          "in": "path",
          "description": "The unique identifier for the document.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "pdc_0SNlurA049MEWV1S6e1qVqBV2xge"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Plans"
        ],
        "operationId": "PlanDocumentsRetrieve",
        "summary": "Retrieve a plan document",
        "description": "Retrieves the details of an existing document for a given plan.",
        "responses": {
          "200": {
            "description": "Returns the plan if it exists and is owned by the plan.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/planDocument"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "planDocument",
                      "id": "pdc_0SNlurA049MEWV1S6e1qVqBV2xge",
                      "createdAt": "2022-07-04T16:20:27Z",
                      "language": "en-US",
                      "name": "My Plan Contract",
                      "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "type": "application/pdf",
                      "url": "https://a.gigscdn.net/p/my-project/01G74ZPB5PQTDESM4JGYR2CWB9.pdf"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/portings": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Portings"
        ],
        "operationId": "PortingsList",
        "summary": "List all portings",
        "description": "Returns a list of portings. The portings returned are sorted by creation date, with the most recently created portings appearing first.",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "The status to filter the portings by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "draft",
                  "initiated",
                  "pending",
                  "informationRequired",
                  "requested",
                  "declined",
                  "completed",
                  "canceled",
                  "expired",
                  "failed"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "subscription",
            "in": "query",
            "description": "The unique identifier of the subscription to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
              ]
            }
          },
          {
            "name": "user",
            "in": "query",
            "description": "The unique identifier of the user to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of portings.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `porting`.",
                      "items": {
                        "$ref": "#/components/schemas/porting"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "porting",
                          "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                          "accountNumber": "123456789",
                          "accountPinExists": true,
                          "accountType": "prepaidUnregistered",
                          "address": {
                            "city": "New York City",
                            "country": "US",
                            "line1": "129 West 81st Street",
                            "line2": "Apartment 5",
                            "postalCode": "10024",
                            "state": "NY"
                          },
                          "behavior": "portIn",
                          "billingPinExists": true,
                          "birthday": "2017-07-21",
                          "canceledAt": "2021-01-21T19:39:53Z",
                          "completedAt": "2021-01-21T19:36:57Z",
                          "createdAt": "2021-01-21T19:12:28Z",
                          "declinedAttempts": 0,
                          "declinedCode": "portingPhoneNumberPortProtected",
                          "declinedMessage": "The phone number has port protection on the provider.",
                          "donorProvider": {
                            "object": "serviceProvider",
                            "id": "svp_0SNlurA01K6GY5L0XJffY8",
                            "country": "US",
                            "name": "AT&T",
                            "recipientProviders": [
                              "p3"
                            ]
                          },
                          "donorProviderApproval": true,
                          "expiredAt": "2021-01-21T19:39:53Z",
                          "failedAt": "2021-01-21T19:39:53Z",
                          "failureReason": "consentNotGiven",
                          "firstName": "Jerry",
                          "lastDeclinedAt": "2021-01-21T19:31:13Z",
                          "lastName": "Seinfeld",
                          "lastRequestedAt": "2021-01-21T19:22:31Z",
                          "phoneNumber": "+19591234567",
                          "provider": "p9",
                          "recipientProvider": {
                            "object": "serviceProvider",
                            "id": "svp_0SNlurA01K6GY5L0XJffY8",
                            "country": "US",
                            "name": "AT&T",
                            "recipientProviders": [
                              "p3"
                            ]
                          },
                          "requestBehavior": "automatic",
                          "required": [
                            "accountNumber",
                            "accountPin",
                            "accountType",
                            "address",
                            "birthday",
                            "donorProvider",
                            "donorProviderApproval",
                            "firstName",
                            "lastName"
                          ],
                          "scheduledOn": "2021-01-21",
                          "status": "draft",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "porting",
                          "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                          "accountNumber": "123456789",
                          "accountPinExists": true,
                          "accountType": "prepaidUnregistered",
                          "address": {
                            "city": "New York City",
                            "country": "US",
                            "line1": "129 West 81st Street",
                            "line2": "Apartment 5",
                            "postalCode": "10024",
                            "state": "NY"
                          },
                          "behavior": "portIn",
                          "billingPinExists": true,
                          "birthday": "2017-07-21",
                          "canceledAt": "2021-01-21T19:39:53Z",
                          "completedAt": "2021-01-21T19:36:57Z",
                          "createdAt": "2021-01-21T19:12:28Z",
                          "declinedAttempts": 0,
                          "declinedCode": "portingPhoneNumberPortProtected",
                          "declinedMessage": "The phone number has port protection on the provider.",
                          "donorProvider": {
                            "object": "serviceProvider",
                            "id": "svp_0SNlurA01K6GY5L0XJffY8",
                            "country": "US",
                            "name": "AT&T",
                            "recipientProviders": [
                              "p3"
                            ]
                          },
                          "donorProviderApproval": true,
                          "expiredAt": "2021-01-21T19:39:53Z",
                          "failedAt": "2021-01-21T19:39:53Z",
                          "failureReason": "consentNotGiven",
                          "firstName": "Jerry",
                          "lastDeclinedAt": "2021-01-21T19:31:13Z",
                          "lastName": "Seinfeld",
                          "lastRequestedAt": "2021-01-21T19:22:31Z",
                          "phoneNumber": "+19591234567",
                          "provider": "p9",
                          "recipientProvider": {
                            "object": "serviceProvider",
                            "id": "svp_0SNlurA01K6GY5L0XJffY8",
                            "country": "US",
                            "name": "AT&T",
                            "recipientProviders": [
                              "p3"
                            ]
                          },
                          "requestBehavior": "automatic",
                          "required": [
                            "accountNumber",
                            "accountPin",
                            "accountType",
                            "address",
                            "birthday",
                            "donorProvider",
                            "donorProviderApproval",
                            "firstName",
                            "lastName"
                          ],
                          "scheduledOn": "2021-01-21",
                          "status": "draft",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "PortingsCreate",
        "summary": "Create a porting",
        "description": "Creates a new porting. It will be created in `draft` status and can be later used to create an order or subscription for the same provider.\n\nOnly some of the fields are required during creation. Some providers require additional fields which are listed in the `required` array property of the porting. It will remain in `informationRequired` status until all required information has been collected.\n\nFor a porting with a `requestBehavior` of `automatic`, the porting will then be requested. For a porting with a `requestBehavior` of `manual`, it stays in `informationRequired` until it is requested via the [request a porting](https://developers.gigs.com/core/portings#request-a-porting) endpoint.\n\nRelated guide: [How Porting Works](https://developers.gigs.com/docs/porting/how-porting-in-works)\n",
        "requestBody": {
          "description": "Porting parameters to create.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "accountNumber": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The account number on the donor service provider.",
                    "examples": [
                      "123456789"
                    ]
                  },
                  "accountPin": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The pin for the account on the donor service provider. This will be used only for the porting.",
                    "examples": [
                      "1234"
                    ]
                  },
                  "accountType": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      null,
                      "postpaidMulti",
                      "postpaidSingle",
                      "prepaidRegistered",
                      "prepaidUnregistered"
                    ],
                    "description": "The type of account on the donor service provider. Required for portings in Ireland.",
                    "examples": [
                      "prepaidUnregistered"
                    ]
                  },
                  "address": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "The address of the account holder on the donor service provider.",
                    "properties": {
                      "city": {
                        "type": "string",
                        "description": "The city/municipality of the address.",
                        "examples": [
                          "New York City"
                        ]
                      },
                      "country": {
                        "type": "string",
                        "description": "The ISO 3166-1 alpha-2 country code of the address.",
                        "examples": [
                          "US"
                        ]
                      },
                      "line1": {
                        "type": "string",
                        "description": "The first line of the address, e.g. street and house number.",
                        "examples": [
                          "129 West 81st Street"
                        ]
                      },
                      "line2": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "TThe second line of the address, e.g. apartment number.",
                        "examples": [
                          "Apartment 5"
                        ]
                      },
                      "postalCode": {
                        "type": "string",
                        "description": "The postal code of the address.",
                        "examples": [
                          "10024"
                        ]
                      },
                      "state": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The state/province/region of the address.",
                        "examples": [
                          "NY"
                        ]
                      }
                    },
                    "required": [
                      "city",
                      "country",
                      "line1"
                    ]
                  },
                  "behavior": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "cancelOnly",
                      "portIn"
                    ],
                    "default": "portIn",
                    "description": "The behavior of the porting.\n\nUse `portIn` to transfer the phone number from\nthe previous provider.\n\nUse `cancelOnly` to cancel the previous service\nwithout transferring the number. This behavior is currently only\navailable for local plans in the United Kingdom.\n\nDefaults to `portIn` if no value is provided.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "portIn"
                    ]
                  },
                  "billingPin": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The billing pin for the account on the donor service provider. This will be used only for the porting.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "1234"
                    ]
                  },
                  "birthday": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date",
                    "description": "The birthday of the account holder on the donor service provider.",
                    "examples": [
                      "2017-07-21"
                    ]
                  },
                  "donorProvider": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier of the donor service provider.",
                    "examples": [
                      "svp_0SNlurA01K6GY5L0XJffY8"
                    ]
                  },
                  "donorProviderApproval": {
                    "type": [
                      "boolean",
                      "null"
                    ],
                    "description": "Whether the donor provider has approved or not the porting.",
                    "examples": [
                      true
                    ]
                  },
                  "firstName": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The first name of the account holder.",
                    "examples": [
                      "Jerry"
                    ]
                  },
                  "lastName": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The last name of the account holder.",
                    "examples": [
                      "Seinfeld"
                    ]
                  },
                  "phoneNumber": {
                    "type": "string",
                    "format": "E.164",
                    "description": "The phone number to port in E.164 string_format.",
                    "examples": [
                      "+19591234567"
                    ]
                  },
                  "provider": {
                    "type": "string",
                    "description": "The name of the receiving network provider.",
                    "examples": [
                      "p9"
                    ]
                  },
                  "requestBehavior": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      null,
                      "automatic",
                      "manual"
                    ],
                    "default": "automatic",
                    "description": "Controls when the porting is submitted to the recipient network provider.\n\nUse `automatic` to have the porting requested automatically as soon as all required information is present.\n\nUse `manual` to withhold that automatic submission, for example to give a user a chance to review the porting first. The porting must then be requested explicitly, once ready, via the [request a porting](https://developers.gigs.com/core/portings#request-a-porting) endpoint. A `manual` porting that has all required information waits in the `informationRequired` status, or in `declined` if it was declined, until it is requested.\n\nDefaults to `automatic` if no value is provided.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "automatic"
                    ]
                  },
                  "scheduledOn": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date",
                    "description": "The date that the porting is scheduled to take effect.\n\nScheduling is only supported by providers in France, Ireland, Sweden and the United Kingdom. Attempting to schedule a porting for any other provider will result in an error. Providers may also apply restrictions to the date.\n\nUse `null` to indicate that the porting should be scheduled as soon as possible. Otherwise, the date provided must be in the future.\n\nIf, by the time the porting is requested from the provider, the scheduled date has already passed, then the porting will instead occur as soon as possible.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "2021-01-21"
                    ]
                  },
                  "user": {
                    "type": "string",
                    "description": "The unique identifier for an existing [user](https://developers.gigs.com/core/users#the-user-resource) the porting should be created for.",
                    "examples": [
                      "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    ]
                  }
                },
                "required": [
                  "phoneNumber",
                  "provider",
                  "user"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "accountNumber": "123456789",
                    "accountPin": "1234",
                    "accountType": "prepaidUnregistered",
                    "address": {
                      "city": "New York City",
                      "country": "US",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY"
                    },
                    "behavior": "portIn",
                    "billingPin": "1234",
                    "birthday": "2017-07-21",
                    "donorProvider": "svp_0SNlurA01K6GY5L0XJffY8",
                    "donorProviderApproval": true,
                    "firstName": "Jerry",
                    "lastName": "Seinfeld",
                    "phoneNumber": "+19591234567",
                    "provider": "p9",
                    "requestBehavior": "automatic",
                    "scheduledOn": "2021-01-21",
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "phoneNumber": "+19591234567",
                    "provider": "p9",
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the created porting.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/porting"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          },
          "503": {
            "$ref": "#/components/responses/serviceUnavailable"
          }
        }
      }
    },
    "/projects/{project}/portings/{porting}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "porting",
          "in": "path",
          "description": "The unique identifier for the porting.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "prt_0SNlurA049MEWV39s2kSYqaat7ZS"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Portings"
        ],
        "operationId": "PortingsRetrieve",
        "summary": "Retrieve a Porting",
        "description": "Retrieves the details of an existing porting.",
        "responses": {
          "200": {
            "description": "Returns the porting.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/porting"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "delete": {
        "tags": [
          "Portings"
        ],
        "operationId": "PortingsDelete",
        "summary": "Delete a draft porting",
        "description": "Deletes a porting that is in the `draft` state.",
        "responses": {
          "200": {
            "description": "Returns the porting.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/porting"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "patch": {
        "tags": [
          "Portings"
        ],
        "operationId": "PortingsUpdate",
        "summary": "Update a porting",
        "description": "Updates a porting with the given parameters.\n\nDepending on the status of the porting, some fields may not be updated anymore.\n\nFor a porting with a `requestBehavior` of `automatic`, the porting will be requested when all the required information is provided. If the porting is declined, it will be retried. To retry a porting without providing any new information, simply update the porting with an empty request.\n\nFor a porting with a `requestBehavior` of `manual`, the porting is only requested via the [request a porting](https://developers.gigs.com/core/portings#request-a-porting) endpoint, including when it was declined.\n\nRelated guide: [How Porting Works](https://developers.gigs.com/docs/core/how-porting-in-works)\n",
        "requestBody": {
          "description": "Porting parameters to update.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "accountNumber": {
                    "type": "string",
                    "description": "The account number on the donor service provider.",
                    "examples": [
                      "123456789"
                    ]
                  },
                  "accountPin": {
                    "type": "string",
                    "description": "The pin for the account on the donor service provider. This will be used only for the porting.",
                    "examples": [
                      "1234"
                    ]
                  },
                  "accountType": {
                    "type": "string",
                    "enum": [
                      "postpaidMulti",
                      "postpaidSingle",
                      "prepaidRegistered",
                      "prepaidUnregistered"
                    ],
                    "description": "The type of account on the donor service provider. Required for portings in Ireland.",
                    "examples": [
                      "prepaidUnregistered"
                    ]
                  },
                  "address": {
                    "type": [
                      "object"
                    ],
                    "description": "The address of the account holder on the donor service provider.",
                    "properties": {
                      "city": {
                        "type": "string",
                        "description": "The city/municipality of the address.",
                        "examples": [
                          "New York City"
                        ]
                      },
                      "country": {
                        "type": "string",
                        "description": "The ISO 3166-1 alpha-2 country code of the address.",
                        "examples": [
                          "US"
                        ]
                      },
                      "line1": {
                        "type": "string",
                        "description": "The first line of the address, e.g. street and house number.",
                        "examples": [
                          "129 West 81st Street"
                        ]
                      },
                      "line2": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "TThe second line of the address, e.g. apartment number.",
                        "examples": [
                          "Apartment 5"
                        ]
                      },
                      "postalCode": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The postal code of the address.",
                        "examples": [
                          "10024"
                        ]
                      },
                      "state": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The state/province/region of the address.",
                        "examples": [
                          "NY"
                        ]
                      }
                    },
                    "required": []
                  },
                  "behavior": {
                    "type": [
                      "string"
                    ],
                    "enum": [
                      "cancelOnly",
                      "portIn"
                    ],
                    "description": "The behavior of the porting.\n\nUse `portIn` to transfer the phone number from\nthe previous provider.\n\nUse `cancelOnly` to cancel the previous service\nwithout transferring the number. This behavior is currently only\navailable for local plans in the United Kingdom.\n\nThis property is only updatable when the porting's status is draft.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "portIn"
                    ]
                  },
                  "billingPin": {
                    "type": "string",
                    "description": "The billing pin for the account on the donor service provider. This will be used only for the porting.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "1234"
                    ]
                  },
                  "birthday": {
                    "type": "string",
                    "format": "date",
                    "description": "The birthday of the account holder on the donor service provider.",
                    "examples": [
                      "2017-07-21"
                    ]
                  },
                  "donorProvider": {
                    "type": "string",
                    "description": "The unique identifier of the donor service provider.",
                    "examples": [
                      "svp_0SNlurA01K6GY5L0XJffY8"
                    ]
                  },
                  "donorProviderApproval": {
                    "type": [
                      "boolean"
                    ],
                    "description": "Whether the donor provider has approved or not the porting.",
                    "examples": [
                      true
                    ]
                  },
                  "firstName": {
                    "type": "string",
                    "description": "The first name of the account holder.",
                    "examples": [
                      "Jerry"
                    ]
                  },
                  "lastName": {
                    "type": "string",
                    "description": "The last name of the account holder.",
                    "examples": [
                      "Seinfeld"
                    ]
                  },
                  "phoneNumber": {
                    "type": "string",
                    "format": "E.164",
                    "description": "The phone number to port in E.164 string_format. This is only updatable when the porting is in a status of: draft, or, for providers `p11` and `p12`, declined or informationRequired.",
                    "examples": [
                      "+19591234567"
                    ]
                  },
                  "provider": {
                    "type": "string",
                    "description": "The ID of the recipient network provider. This is only updatable when the porting is in a status of: draft",
                    "examples": [
                      "p9"
                    ]
                  },
                  "requestBehavior": {
                    "type": [
                      "string"
                    ],
                    "enum": [
                      "automatic",
                      "manual"
                    ],
                    "description": "Controls when the porting is submitted to the recipient network provider.\n\nUse `automatic` to have the porting requested automatically as soon as all required information is present.\n\nUse `manual` to withhold that automatic submission, for example to give a user a chance to review the porting first. The porting must then be requested explicitly, once ready, via the [request a porting](https://developers.gigs.com/core/portings#request-a-porting) endpoint. A `manual` porting that has all required information waits in the `informationRequired` status, or in `declined` if it was declined, until it is requested.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "automatic"
                    ]
                  },
                  "scheduledOn": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date",
                    "description": "Date when the porting is scheduled to take effect.\n\nScheduling is only supported by providers in France, Ireland, Sweden and the United Kingdom. Attempting to schedule a porting for any other provider will result in an error. Providers may also apply restrictions to the date.\n\nUse `null` to indicate that the porting should be scheduled as soon as possible. Otherwise, the date provided must be in the future.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "2021-01-21"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "accountNumber": "123456789",
                    "accountPin": "1234",
                    "accountType": "prepaidUnregistered",
                    "address": {
                      "city": "New York City",
                      "country": "US",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY"
                    },
                    "behavior": "portIn",
                    "billingPin": "1234",
                    "birthday": "2017-07-21",
                    "donorProvider": "svp_0SNlurA01K6GY5L0XJffY8",
                    "donorProviderApproval": true,
                    "firstName": "Jerry",
                    "lastName": "Seinfeld",
                    "phoneNumber": "+19591234567",
                    "provider": "p9",
                    "requestBehavior": "automatic",
                    "scheduledOn": "2021-01-21"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the updated porting.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/porting"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          },
          "503": {
            "$ref": "#/components/responses/serviceUnavailable"
          }
        }
      }
    },
    "/projects/{project}/portings/{porting}/cancel": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "porting",
          "in": "path",
          "description": "The unique identifier for the porting.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "prt_0SNlurA049MEWV39s2kSYqaat7ZS"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "PortingsCancel",
        "summary": "Cancel a porting",
        "description": "Cancels a porting. A porting can be cancelled in the following situations:\n  - it is in the `initiated`, `declined` or `informationRequired` state,\n  - it is in the `pending` state **and** the porting request has not been sent to the provider yet,\n  - it is in the `requested` state **and** it is scheduled for a future date that is within the provider's cancellation window.\n\nCanceling a porting will result in the activation of the subscription with a new number. To cancel the whole process, end the subscription instead.\n",
        "responses": {
          "200": {
            "description": "Returns the canceled porting.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/porting"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/portings/{porting}/request": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "porting",
          "in": "path",
          "description": "The unique identifier for the porting.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "prt_0SNlurA049MEWV39s2kSYqaat7ZS"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "PortingsRequest",
        "summary": "Request a porting",
        "description": "Requests a porting from the recipient network provider.\n\nOnly portings with a `requestBehavior` of `manual` can be requested with this endpoint. The porting must be in the `informationRequired` or `declined` status, have all required information and be attached to a subscription that is pending or active.\n\nRelated guide: [How Porting Works](https://developers.gigs.com/docs/core/how-porting-in-works)\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "responses": {
          "200": {
            "description": "Returns the porting.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/porting"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/portings/search": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "PortingsSearch",
        "summary": "Search for portings",
        "description": "Searches for existing portings matching the given parameters.",
        "requestBody": {
          "description": "Porting attributes to search for.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "phoneNumber": {
                    "type": "string",
                    "format": "E.164",
                    "description": "The E.164-formatted phone number associated with the porting.",
                    "examples": [
                      "+12065550123"
                    ]
                  }
                },
                "required": [
                  "phoneNumber"
                ]
              },
              "examples": {
                "Example": {
                  "summary": "Example",
                  "value": {
                    "phoneNumber": "+12065550123"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns a list of portings matching the search criteria.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `porting`.",
                      "items": {
                        "$ref": "#/components/schemas/porting"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "porting",
                          "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                          "accountNumber": "123456789",
                          "accountPinExists": true,
                          "accountType": "prepaidUnregistered",
                          "address": {
                            "city": "New York City",
                            "country": "US",
                            "line1": "129 West 81st Street",
                            "line2": "Apartment 5",
                            "postalCode": "10024",
                            "state": "NY"
                          },
                          "behavior": "portIn",
                          "billingPinExists": true,
                          "birthday": "2017-07-21",
                          "canceledAt": "2021-01-21T19:39:53Z",
                          "completedAt": "2021-01-21T19:36:57Z",
                          "createdAt": "2021-01-21T19:12:28Z",
                          "declinedAttempts": 0,
                          "declinedCode": "portingPhoneNumberPortProtected",
                          "declinedMessage": "The phone number has port protection on the provider.",
                          "donorProvider": {
                            "object": "serviceProvider",
                            "id": "svp_0SNlurA01K6GY5L0XJffY8",
                            "country": "US",
                            "name": "AT&T",
                            "recipientProviders": [
                              "p3"
                            ]
                          },
                          "donorProviderApproval": true,
                          "expiredAt": "2021-01-21T19:39:53Z",
                          "failedAt": "2021-01-21T19:39:53Z",
                          "failureReason": "consentNotGiven",
                          "firstName": "Jerry",
                          "lastDeclinedAt": "2021-01-21T19:31:13Z",
                          "lastName": "Seinfeld",
                          "lastRequestedAt": "2021-01-21T19:22:31Z",
                          "phoneNumber": "+19591234567",
                          "provider": "p9",
                          "recipientProvider": {
                            "object": "serviceProvider",
                            "id": "svp_0SNlurA01K6GY5L0XJffY8",
                            "country": "US",
                            "name": "AT&T",
                            "recipientProviders": [
                              "p3"
                            ]
                          },
                          "requestBehavior": "automatic",
                          "required": [
                            "accountNumber",
                            "accountPin",
                            "accountType",
                            "address",
                            "birthday",
                            "donorProvider",
                            "donorProviderApproval",
                            "firstName",
                            "lastName"
                          ],
                          "scheduledOn": "2021-01-21",
                          "status": "draft",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "porting",
                          "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                          "accountNumber": "123456789",
                          "accountPinExists": true,
                          "accountType": "prepaidUnregistered",
                          "address": {
                            "city": "New York City",
                            "country": "US",
                            "line1": "129 West 81st Street",
                            "line2": "Apartment 5",
                            "postalCode": "10024",
                            "state": "NY"
                          },
                          "behavior": "portIn",
                          "billingPinExists": true,
                          "birthday": "2017-07-21",
                          "canceledAt": "2021-01-21T19:39:53Z",
                          "completedAt": "2021-01-21T19:36:57Z",
                          "createdAt": "2021-01-21T19:12:28Z",
                          "declinedAttempts": 0,
                          "declinedCode": "portingPhoneNumberPortProtected",
                          "declinedMessage": "The phone number has port protection on the provider.",
                          "donorProvider": {
                            "object": "serviceProvider",
                            "id": "svp_0SNlurA01K6GY5L0XJffY8",
                            "country": "US",
                            "name": "AT&T",
                            "recipientProviders": [
                              "p3"
                            ]
                          },
                          "donorProviderApproval": true,
                          "expiredAt": "2021-01-21T19:39:53Z",
                          "failedAt": "2021-01-21T19:39:53Z",
                          "failureReason": "consentNotGiven",
                          "firstName": "Jerry",
                          "lastDeclinedAt": "2021-01-21T19:31:13Z",
                          "lastName": "Seinfeld",
                          "lastRequestedAt": "2021-01-21T19:22:31Z",
                          "phoneNumber": "+19591234567",
                          "provider": "p9",
                          "recipientProvider": {
                            "object": "serviceProvider",
                            "id": "svp_0SNlurA01K6GY5L0XJffY8",
                            "country": "US",
                            "name": "AT&T",
                            "recipientProviders": [
                              "p3"
                            ]
                          },
                          "requestBehavior": "automatic",
                          "required": [
                            "accountNumber",
                            "accountPin",
                            "accountType",
                            "address",
                            "birthday",
                            "donorProvider",
                            "donorProviderApproval",
                            "firstName",
                            "lastName"
                          ],
                          "scheduledOn": "2021-01-21",
                          "status": "draft",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/portOuts": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "PortOutsList",
        "summary": "List all port outs",
        "description": "Returns a list of port outs.",
        "parameters": [
          {
            "name": "subscription",
            "in": "query",
            "description": "The unique identifier of the subscription to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "A comma-separated list of statuses to filter the port outs by. Only initiated, processing and issued port outs are returned by default.",
            "schema": {
              "type": "array",
              "default": [
                "initiated",
                "issued",
                "processing"
              ],
              "items": {
                "type": "string",
                "enum": [
                  "completed",
                  "expired",
                  "failed",
                  "initiated",
                  "issued",
                  "processing"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of port outs.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `portOut`.",
                      "items": {
                        "$ref": "#/components/schemas/portOut"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "portOut",
                          "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                          "behavior": "portOut",
                          "completedAt": "2022-02-21T19:38:34Z",
                          "createdAt": "2020-01-01T00:00:00Z",
                          "expirationRequestedAt": "2022-02-21T19:38:12Z",
                          "expiredAt": "2022-02-21T19:38:34Z",
                          "failureReason": "consentNotGiven",
                          "status": "issued",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "portOut",
                          "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                          "behavior": "portOut",
                          "completedAt": "2022-02-21T19:38:34Z",
                          "createdAt": "2020-01-01T00:00:00Z",
                          "expirationRequestedAt": "2022-02-21T19:38:12Z",
                          "expiredAt": "2022-02-21T19:38:34Z",
                          "failureReason": "consentNotGiven",
                          "status": "issued",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "PortOutsCreate",
        "summary": "Create port out",
        "description": "Create a new port out.",
        "parameters": [],
        "requestBody": {
          "description": "Port out parameters to create.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "behavior": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "cancelOnly",
                      "portOut"
                    ],
                    "default": "portOut",
                    "description": "The behavior of the port out.\n\nA value of `portOut` indicates that using this\nport out will transfer the phone number to the recipient provider.\n\nPort out with behavior `cancelOnly`\nwill cancel the service without transferring the number. This behavior is\ncurrently only available for local plans in the United Kingdom.\n\nDefaults to `portOut` if no value is provided.\n",
                    "examples": [
                      "portOut"
                    ]
                  },
                  "subscription": {
                    "type": [
                      "string"
                    ],
                    "description": "Unique identifier of the subscription the port out applies to.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "behavior": "portOut",
                    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the created port out.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/portOut"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/portOuts/{portOut}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "portOut",
          "in": "path",
          "description": "The unique identifier for the port out.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "PortOutsRetrieve",
        "summary": "Retrieve port out",
        "description": "Retrieves the details of an existing port out.",
        "responses": {
          "200": {
            "description": "Returns the port out.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/portOut"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/portOuts/{portOut}/credentials": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "portOut",
          "in": "path",
          "description": "The unique identifier for the port out.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "PortOutCredentialsRetrieve",
        "summary": "Retrieve port out credentials",
        "description": "Retrieve the credentials of an issued port out.",
        "responses": {
          "200": {
            "description": "Returns the port out credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/portOutCredentials"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "portOutCredentials",
                      "accountNumber": "123456789",
                      "accountPin": "1234",
                      "portOut": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/portOuts/{portOut}/expire": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "portOut",
          "in": "path",
          "description": "The unique identifier for the port out.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "PortOutsExpire",
        "summary": "Expire existing port out credentials",
        "description": "Requests expiration of the port out, making the credentials unusable. Port outs with a status\nof `\"initiated\"`, `\"processing\"` or `\"issued\"` can be expired. The returned port out\nwill have the status as before, but with an `expirationRequestedAt` timestamp.\n",
        "responses": {
          "200": {
            "description": "Returns the port out",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/portOut"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects": {
      "get": {
        "tags": [
          "Projects"
        ],
        "operationId": "ProjectsList",
        "summary": "List all projects",
        "description": "Returns a list of projects. The projects returned are sorted by creation date, with the most recently created projects appearing first.",
        "parameters": [
          {
            "name": "organization",
            "in": "query",
            "description": "The unique identifier for the organization to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "org_0SNlurA04kOdemVEMVZQBF"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of projects.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `project`.",
                      "items": {
                        "$ref": "#/components/schemas/project"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "project",
                          "id": "gigs",
                          "billing": {
                            "advanceInvoicingDays": 7,
                            "invoiceGracePeriodDays": 3,
                            "invoiceOverdueDays": 3,
                            "invoiceOverduePeriodDays": 1,
                            "invoiceOverdueAction": "end",
                            "currency": "USD",
                            "restrictBehavior": null,
                            "restoreBehavior": null,
                            "paymentBehavior": "manual",
                            "taxBehavior": "exclusive",
                            "recoveryFeePercentage": 10.0,
                            "recoveryFeeAmount": {
                              "amount": 150,
                              "currency": "USD"
                            }
                          },
                          "consent": {
                            "deliveryMethods": [
                              "emailLink"
                            ],
                            "approvalBaseUrl": "https://consent.gigs.com/consent"
                          },
                          "createdAt": "2021-01-21T19:32:13Z",
                          "image": "https://a.gigscdn.net/p/gigs/icon.png",
                          "legal": {
                            "name": "Gigs Inc.",
                            "city": "New York City",
                            "country": "US",
                            "line1": "129 West 81st Street",
                            "line2": "Apartment 5",
                            "postalCode": "10024",
                            "state": "NY"
                          },
                          "locales": [
                            "en-US"
                          ],
                          "name": "Gigs Connect",
                          "organization": {
                            "object": "organization",
                            "id": "org_0SNlurA04kOdemVEMVZQBF",
                            "createdAt": "2021-02-01T13:21:30Z",
                            "name": "Gigs"
                          },
                          "payments": {
                            "currency": "USD",
                            "mode": "live"
                          },
                          "subscriptionOwner": "user",
                          "support": {
                            "email": "support@gigs.com",
                            "phoneNumber": "+12345678900"
                          },
                          "tax": {
                            "country": "US"
                          },
                          "type": "live"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "project",
                          "id": "gigs",
                          "billing": {
                            "advanceInvoicingDays": 7,
                            "invoiceGracePeriodDays": 3,
                            "invoiceOverdueDays": 3,
                            "invoiceOverduePeriodDays": 1,
                            "invoiceOverdueAction": "end",
                            "currency": "USD",
                            "restrictBehavior": null,
                            "restoreBehavior": null,
                            "paymentBehavior": "manual",
                            "taxBehavior": "exclusive",
                            "recoveryFeePercentage": 10.0,
                            "recoveryFeeAmount": {
                              "amount": 150,
                              "currency": "USD"
                            }
                          },
                          "consent": {},
                          "createdAt": "2021-01-21T19:32:13Z",
                          "image": "https://a.gigscdn.net/p/gigs/icon.png",
                          "legal": {
                            "name": "Gigs Inc.",
                            "city": "New York City",
                            "country": "US",
                            "line1": "129 West 81st Street",
                            "line2": "Apartment 5",
                            "postalCode": "10024",
                            "state": "NY"
                          },
                          "locales": [
                            "en-US"
                          ],
                          "name": "Gigs Connect",
                          "organization": {
                            "object": "organization",
                            "id": "org_0SNlurA04kOdemVEMVZQBF",
                            "createdAt": "2021-02-01T13:21:30Z",
                            "name": "Gigs"
                          },
                          "payments": {
                            "currency": "USD",
                            "mode": "live"
                          },
                          "subscriptionOwner": "user",
                          "support": {
                            "email": "support@gigs.com",
                            "phoneNumber": "+12345678900"
                          },
                          "tax": {
                            "country": "US"
                          },
                          "type": "live"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Projects"
        ],
        "operationId": "ProjectsRetrieve",
        "summary": "Retrieve a project",
        "description": "Retrieves the details of an existing project accessible by the API client.",
        "responses": {
          "200": {
            "description": "Returns the project object if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/project"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {
                        "deliveryMethods": [
                          "emailLink"
                        ],
                        "approvalBaseUrl": "https://consent.gigs.com/consent"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/credentials": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Projects"
        ],
        "operationId": "ProjectCredentialsRetrieve",
        "summary": "Retrieve the project credentials",
        "description": "Retrieve the credentials of an existing project.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "responses": {
          "200": {
            "description": "Returns the project credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/projectCredentials"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "projectCredentials",
                      "paymentsKey": "pk_test_XXooYYauvdEDq12NiTphI7sa"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/serviceProviders": {
      "get": {
        "tags": [
          "Portings"
        ],
        "operationId": "ServiceProvidersList",
        "summary": "List all service providers",
        "description": "Returns a list of service providers. It is recommended that callers provide either a recipient provider or country to filter for relevant service providers.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "parameters": [
          {
            "name": "recipientProvider",
            "in": "query",
            "description": "Only return service providers that have the given network provider as supported porting recipient.",
            "schema": {
              "type": "string",
              "examples": [
                "p7"
              ]
            }
          },
          {
            "name": "country",
            "in": "query",
            "description": "Only return service providers for the given country represented by the ISO 3166-1 alpha-2 country code.",
            "schema": {
              "type": "string",
              "examples": [
                "US"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of service providers.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `serviceProvider`.",
                      "items": {
                        "$ref": "#/components/schemas/serviceProvider"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/serviceProviders/{serviceProvider}": {
      "parameters": [
        {
          "name": "serviceProvider",
          "in": "path",
          "description": "The unique identifier for the service provider.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "svp_0SNlurA01K6GY5L0XJffY8"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Portings"
        ],
        "operationId": "ServiceProvidersRetrieve",
        "summary": "Retrieve a service provider",
        "description": "Retrieves the details of a service provider.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "responses": {
          "200": {
            "description": "Returns the service provider object if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/serviceProvider"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "serviceProvider",
                      "id": "svp_0SNlurA01K6GY5L0XJffY8",
                      "country": "US",
                      "name": "AT&T",
                      "recipientProviders": [
                        "p3"
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/sims": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "SIMs"
        ],
        "operationId": "SimsList",
        "summary": "List all SIMs",
        "description": "Returns a list of SIMs. The SIMs returned are sorted by creation date, with the most recently created SIMs appearing first.",
        "parameters": [
          {
            "name": "provider",
            "in": "query",
            "description": "The network provider ID for the sim to be filtered by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "examples": [
                  "p3"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "status",
            "in": "query",
            "description": "A comma-separated list of statuses to filter the sims by.",
            "schema": {
              "type": "array",
              "default": [
                "inactive",
                "active"
              ],
              "items": {
                "type": "string",
                "enum": [
                  "inactive",
                  "active",
                  "retired"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "type",
            "in": "query",
            "description": "The type for the sim to be filtered by.",
            "schema": {
              "type": "string",
              "enum": [
                "eSIM",
                "pSIM"
              ]
            }
          },
          {
            "name": "user",
            "in": "query",
            "description": "The unique identifier for the user to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of SIMs.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `sim`.",
                      "items": {
                        "$ref": "#/components/schemas/sim"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/sims/{sim}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "sim",
          "in": "path",
          "description": "The unique identifier for the SIM.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "SIMs"
        ],
        "operationId": "SimsRetrieve",
        "summary": "Retrieve a SIM",
        "description": "Retrieve the details of an existing SIM which the authenticated user is authorized to view.",
        "responses": {
          "200": {
            "description": "Returns the SIM if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sim"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "patch": {
        "tags": [
          "SIMs"
        ],
        "operationId": "SimsUpdate",
        "summary": "Update a SIM",
        "description": "Update the details of an existing SIM.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "metadata": {}
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "description": "Returns the updates SIM.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sim"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/sims/{sim}/credentials": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "sim",
          "in": "path",
          "description": "The unique identifier for the SIM.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "SIMs"
        ],
        "operationId": "SimCredentialsRetrieve",
        "summary": "Retrieve the SIM credentials",
        "description": "Retrieve the credentials of an existing SIM.",
        "responses": {
          "200": {
            "description": "Returns the SIM credentials.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/simCredentials"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "simCredentials",
                      "activationCode": "LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2",
                      "androidInstallUrl": "https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2",
                      "iosInstallUrl": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2",
                      "puk1": "12345678",
                      "puk2": "12345678",
                      "qrCodeUrl": "https://files.gigs.com/qrcode/example/pUNIvfeLBNQ.png",
                      "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/sims/search": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "SimsSearch",
        "summary": "Search for SIMs",
        "description": "Searches for existing SIMs matching the given parameters.",
        "requestBody": {
          "description": "SIM attributes to search for.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "iccid": {
                    "type": "string",
                    "pattern": "^([0-9]{19}[Ff]?|[0-9]{20})$",
                    "description": "The ICCID (integrated circuit card identifier) associated with the SIM.",
                    "examples": [
                      "89883070000007537119"
                    ]
                  },
                  "type": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "default": [
                      "eSIM",
                      "pSIM"
                    ],
                    "description": "Optional type of the SIM card, either `eSIM`, `pSIM` or both.",
                    "items": {
                      "type": "string",
                      "enum": [
                        "eSIM",
                        "pSIM"
                      ]
                    }
                  }
                },
                "required": [
                  "iccid"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "iccid": "89883070000007537119",
                    "type": [
                      "eSIM"
                    ]
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "iccid": "89883070000007537119"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns a list schema response with all found SIMs.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `sim`.",
                      "items": {
                        "$ref": "#/components/schemas/sim"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/sims/{sim}/suspend": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "sim",
          "in": "path",
          "description": "The unique identifier for the SIM.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "SimsSuspend",
        "summary": "Suspend a SIM",
        "description": "Suspends all connectivity of the SIM, blocking voice, SMS and data, for example when the device is lost or stolen.\nThe subscription, the phone number and billing are not affected.\n\nIf the SIM is still suspended 30 days after the suspension took effect, its subscription ends.\nUnsuspending the SIM before then cancels the end.\n\nThe returned SIM includes a `suspension` object with `status: suspending`. The status changes to `suspended` once the network provider confirms the suspension.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "responses": {
          "200": {
            "description": "Returns the SIM with the requested suspension.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sim"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": {
                        "status": "suspending",
                        "updatedAt": "2026-09-24T10:00:00Z"
                      },
                      "type": "eSIM"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/sims/{sim}/unsuspend": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "sim",
          "in": "path",
          "description": "The unique identifier for the SIM.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "SimsUnsuspend",
        "summary": "Unsuspend a SIM",
        "description": "Restores the connectivity of a suspended SIM, for example once a lost device is recovered.\n\nThe returned SIM includes a `suspension` object with `status: unsuspending`. The SIM has no service until the network provider confirms, at which point `suspension` is cleared.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "responses": {
          "200": {
            "description": "Returns the SIM, which stays suspended until the network provider confirms it can proceed to unsuspend.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/sim"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": {
                        "status": "unsuspending",
                        "updatedAt": "2026-09-24T10:00:00Z"
                      },
                      "type": "eSIM"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsList",
        "summary": "List all subscriptions",
        "description": "Returns a list of subscriptions. The subscriptions returned are sorted by creation date, with the most recently created subscriptions appearing first.",
        "parameters": [
          {
            "name": "user",
            "in": "query",
            "description": "The unique identifier for the user to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
              ]
            }
          },
          {
            "name": "plan",
            "in": "query",
            "description": "The unique identifier for the plan to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
              ]
            }
          },
          {
            "name": "sim",
            "in": "query",
            "description": "The unique identifier for the sim to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "A comma-separated list of statuses to filter the subscriptions by. Only pending and active subscriptions are returned by default.",
            "schema": {
              "type": "array",
              "default": [
                "pending",
                "initiated",
                "active",
                "restricted"
              ],
              "items": {
                "type": "string",
                "enum": [
                  "pending",
                  "initiated",
                  "active",
                  "restricted",
                  "ended"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a list of subscription objects.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `subscription`.",
                      "items": {
                        "$ref": "#/components/schemas/subscription"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "subscription",
                          "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "metadata": {},
                          "activatedAt": "2021-01-21T19:38:34Z",
                          "billing": {
                            "discount": {
                              "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                              "expiresAt": "2021-02-20T19:38:34Z"
                            },
                            "invoiceGracePeriodDays": 3,
                            "invoiceOverduePeriodDays": 1,
                            "invoiceOverdueAction": null,
                            "restrictBehavior": null,
                            "restoreBehavior": null
                          },
                          "canceledAt": "2021-01-29T13:22:51Z",
                          "cancellationDetails": {
                            "cause": "cancellationRequested",
                            "userReason": "connectivityIssues"
                          },
                          "createdAt": "2021-01-21T19:32:13Z",
                          "currentPeriod": {
                            "number": 1,
                            "start": "2021-01-21T19:32:13Z",
                            "end": "2021-02-20T19:38:34Z"
                          },
                          "earliestEndAt": "2021-02-20T19:38:34Z",
                          "endedAt": "2021-02-20T19:38:34Z",
                          "firstUsageAt": "2021-01-21T19:38:34Z",
                          "lastPorting": {
                            "object": "porting",
                            "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                            "accountNumber": "123456789",
                            "accountPinExists": true,
                            "accountType": "prepaidUnregistered",
                            "address": {
                              "city": "New York City",
                              "country": "US",
                              "line1": "129 West 81st Street",
                              "line2": "Apartment 5",
                              "postalCode": "10024",
                              "state": "NY"
                            },
                            "behavior": "portIn",
                            "billingPinExists": true,
                            "birthday": "2017-07-21",
                            "canceledAt": "2021-01-21T19:39:53Z",
                            "completedAt": "2021-01-21T19:36:57Z",
                            "createdAt": "2021-01-21T19:12:28Z",
                            "declinedAttempts": 0,
                            "declinedCode": "portingPhoneNumberPortProtected",
                            "declinedMessage": "The phone number has port protection on the provider.",
                            "donorProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "donorProviderApproval": true,
                            "expiredAt": "2021-01-21T19:39:53Z",
                            "failedAt": "2021-01-21T19:39:53Z",
                            "failureReason": "consentNotGiven",
                            "firstName": "Jerry",
                            "lastDeclinedAt": "2021-01-21T19:31:13Z",
                            "lastName": "Seinfeld",
                            "lastRequestedAt": "2021-01-21T19:22:31Z",
                            "phoneNumber": "+19591234567",
                            "provider": "p9",
                            "recipientProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "requestBehavior": "automatic",
                            "required": [
                              "accountNumber",
                              "accountPin",
                              "accountType",
                              "address",
                              "birthday",
                              "donorProvider",
                              "donorProviderApproval",
                              "firstName",
                              "lastName"
                            ],
                            "scheduledOn": "2021-01-21",
                            "status": "draft",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                          },
                          "phoneNumber": "+19591234567",
                          "plan": {
                            "object": "plan",
                            "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                            "metadata": {},
                            "activationTrigger": "creation",
                            "allowances": {
                              "dataBytes": 10000000000,
                              "voiceSeconds": 30000,
                              "smsMessages": 100
                            },
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "createdAt": "2021-01-21T19:38:34Z",
                            "description": "A data plan you will love! Operates in most countries of the world.",
                            "firstPeriodTrigger": "creation",
                            "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                            "limits": {
                              "dataBytes": 100000000000,
                              "bandwidthBitsPerSecond": 100000000,
                              "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"
                            ],
                            "status": "available",
                            "validity": {
                              "minimumPeriods": 12,
                              "type": "recurring",
                              "unit": "day",
                              "value": 7
                            },
                            "data": 10000000000,
                            "dataUnit": "byte",
                            "sms": 100,
                            "smsUnit": "message",
                            "voice": 30000,
                            "voiceUnit": "second"
                          },
                          "restoreRequestedAt": "2021-02-21T19:38:34Z",
                          "restrictedAt": "2021-02-21T19:38:34Z",
                          "restrictionDetails": {
                            "restrictBehavior": "incomingOnly",
                            "restoreBehavior": "resetPeriodAnchor",
                            "cause": "invoiceOverdue"
                          },
                          "sim": {
                            "object": "sim",
                            "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                            "metadata": {},
                            "createdAt": "2021-01-21T19:38:34Z",
                            "iccid": "89883070000007537119",
                            "provider": "p9",
                            "status": "inactive",
                            "suspension": null,
                            "type": "eSIM"
                          },
                          "status": "pending",
                          "user": {
                            "object": "user",
                            "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                            "metadata": {},
                            "birthday": "2017-07-21",
                            "createdAt": "2021-01-21T19:38:34Z",
                            "email": "jerry@example.com",
                            "emailVerified": true,
                            "fullName": "Jerry Seinfeld",
                            "preferredLocale": "en-US",
                            "status": "active"
                          },
                          "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                          "porting": {
                            "object": "porting",
                            "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                            "accountNumber": "123456789",
                            "accountPinExists": true,
                            "accountType": "prepaidUnregistered",
                            "address": {
                              "city": "New York City",
                              "country": "US",
                              "line1": "129 West 81st Street",
                              "line2": "Apartment 5",
                              "postalCode": "10024",
                              "state": "NY"
                            },
                            "behavior": "portIn",
                            "billingPinExists": true,
                            "birthday": "2017-07-21",
                            "canceledAt": "2021-01-21T19:39:53Z",
                            "completedAt": "2021-01-21T19:36:57Z",
                            "createdAt": "2021-01-21T19:12:28Z",
                            "declinedAttempts": 0,
                            "declinedCode": "portingPhoneNumberPortProtected",
                            "declinedMessage": "The phone number has port protection on the provider.",
                            "donorProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "donorProviderApproval": true,
                            "expiredAt": "2021-01-21T19:39:53Z",
                            "failedAt": "2021-01-21T19:39:53Z",
                            "failureReason": "consentNotGiven",
                            "firstName": "Jerry",
                            "lastDeclinedAt": "2021-01-21T19:31:13Z",
                            "lastName": "Seinfeld",
                            "lastRequestedAt": "2021-01-21T19:22:31Z",
                            "phoneNumber": "+19591234567",
                            "provider": "p9",
                            "recipientProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "requestBehavior": "automatic",
                            "required": [
                              "accountNumber",
                              "accountPin",
                              "accountType",
                              "address",
                              "birthday",
                              "donorProvider",
                              "donorProviderApproval",
                              "firstName",
                              "lastName"
                            ],
                            "scheduledOn": "2021-01-21",
                            "status": "draft",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                          }
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "subscription",
                          "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "metadata": {},
                          "activatedAt": "2021-01-21T19:38:34Z",
                          "billing": {
                            "discount": {
                              "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                              "expiresAt": "2021-02-20T19:38:34Z"
                            },
                            "invoiceGracePeriodDays": 3,
                            "invoiceOverduePeriodDays": 1,
                            "invoiceOverdueAction": null,
                            "restrictBehavior": null,
                            "restoreBehavior": null
                          },
                          "canceledAt": "2021-01-29T13:22:51Z",
                          "cancellationDetails": {},
                          "createdAt": "2021-01-21T19:32:13Z",
                          "currentPeriod": {
                            "number": 1,
                            "start": "2021-01-21T19:32:13Z",
                            "end": "2021-02-20T19:38:34Z"
                          },
                          "earliestEndAt": "2021-02-20T19:38:34Z",
                          "endedAt": "2021-02-20T19:38:34Z",
                          "firstUsageAt": "2021-01-21T19:38:34Z",
                          "lastPorting": {
                            "object": "porting",
                            "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                            "accountNumber": "123456789",
                            "accountPinExists": true,
                            "accountType": "prepaidUnregistered",
                            "address": {
                              "city": "New York City",
                              "country": "US",
                              "line1": "129 West 81st Street",
                              "line2": "Apartment 5",
                              "postalCode": "10024",
                              "state": "NY"
                            },
                            "behavior": "portIn",
                            "billingPinExists": true,
                            "birthday": "2017-07-21",
                            "canceledAt": "2021-01-21T19:39:53Z",
                            "completedAt": "2021-01-21T19:36:57Z",
                            "createdAt": "2021-01-21T19:12:28Z",
                            "declinedAttempts": 0,
                            "declinedCode": "portingPhoneNumberPortProtected",
                            "declinedMessage": "The phone number has port protection on the provider.",
                            "donorProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "donorProviderApproval": true,
                            "expiredAt": "2021-01-21T19:39:53Z",
                            "failedAt": "2021-01-21T19:39:53Z",
                            "failureReason": "consentNotGiven",
                            "firstName": "Jerry",
                            "lastDeclinedAt": "2021-01-21T19:31:13Z",
                            "lastName": "Seinfeld",
                            "lastRequestedAt": "2021-01-21T19:22:31Z",
                            "phoneNumber": "+19591234567",
                            "provider": "p9",
                            "recipientProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "requestBehavior": "automatic",
                            "required": [
                              "accountNumber",
                              "accountPin",
                              "accountType",
                              "address",
                              "birthday",
                              "donorProvider",
                              "donorProviderApproval",
                              "firstName",
                              "lastName"
                            ],
                            "scheduledOn": "2021-01-21",
                            "status": "draft",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                          },
                          "phoneNumber": "+19591234567",
                          "plan": {
                            "object": "plan",
                            "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                            "metadata": {},
                            "activationTrigger": "creation",
                            "allowances": {
                              "dataBytes": 10000000000,
                              "voiceSeconds": 30000,
                              "smsMessages": 100
                            },
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "createdAt": "2021-01-21T19:38:34Z",
                            "description": "A data plan you will love! Operates in most countries of the world.",
                            "firstPeriodTrigger": "creation",
                            "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                            "limits": {
                              "dataBytes": 100000000000,
                              "bandwidthBitsPerSecond": 100000000,
                              "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"
                            ],
                            "status": "available",
                            "validity": {
                              "minimumPeriods": 12,
                              "type": "recurring",
                              "unit": "day",
                              "value": 7
                            },
                            "data": 10000000000,
                            "dataUnit": "byte",
                            "sms": 100,
                            "smsUnit": "message",
                            "voice": 30000,
                            "voiceUnit": "second"
                          },
                          "restoreRequestedAt": "2021-02-21T19:38:34Z",
                          "restrictedAt": "2021-02-21T19:38:34Z",
                          "restrictionDetails": {
                            "restrictBehavior": "incomingOnly",
                            "restoreBehavior": "resetPeriodAnchor",
                            "cause": "invoiceOverdue"
                          },
                          "sim": {
                            "object": "sim",
                            "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                            "metadata": {},
                            "createdAt": "2021-01-21T19:38:34Z",
                            "iccid": "89883070000007537119",
                            "provider": "p9",
                            "status": "inactive",
                            "suspension": null,
                            "type": "eSIM"
                          },
                          "status": "pending",
                          "user": {
                            "object": "user",
                            "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                            "metadata": {},
                            "birthday": "2017-07-21",
                            "createdAt": "2021-01-21T19:38:34Z",
                            "email": "jerry@example.com",
                            "emailVerified": true,
                            "fullName": "Jerry Seinfeld",
                            "preferredLocale": "en-US",
                            "status": "active"
                          },
                          "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                          "porting": {
                            "object": "porting",
                            "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                            "accountNumber": "123456789",
                            "accountPinExists": true,
                            "accountType": "prepaidUnregistered",
                            "address": {
                              "city": "New York City",
                              "country": "US",
                              "line1": "129 West 81st Street",
                              "line2": "Apartment 5",
                              "postalCode": "10024",
                              "state": "NY"
                            },
                            "behavior": "portIn",
                            "billingPinExists": true,
                            "birthday": "2017-07-21",
                            "canceledAt": "2021-01-21T19:39:53Z",
                            "completedAt": "2021-01-21T19:36:57Z",
                            "createdAt": "2021-01-21T19:12:28Z",
                            "declinedAttempts": 0,
                            "declinedCode": "portingPhoneNumberPortProtected",
                            "declinedMessage": "The phone number has port protection on the provider.",
                            "donorProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "donorProviderApproval": true,
                            "expiredAt": "2021-01-21T19:39:53Z",
                            "failedAt": "2021-01-21T19:39:53Z",
                            "failureReason": "consentNotGiven",
                            "firstName": "Jerry",
                            "lastDeclinedAt": "2021-01-21T19:31:13Z",
                            "lastName": "Seinfeld",
                            "lastRequestedAt": "2021-01-21T19:22:31Z",
                            "phoneNumber": "+19591234567",
                            "provider": "p9",
                            "recipientProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "requestBehavior": "automatic",
                            "required": [
                              "accountNumber",
                              "accountPin",
                              "accountType",
                              "address",
                              "birthday",
                              "donorProvider",
                              "donorProviderApproval",
                              "firstName",
                              "lastName"
                            ],
                            "scheduledOn": "2021-01-21",
                            "status": "draft",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                          }
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsCreate",
        "summary": "Create a subscription",
        "description": "Creates a new subscription for an existing user in the specified project.",
        "parameters": [],
        "requestBody": {
          "description": "Optional and required parameters to be passed in the request body to create a new subscription:",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "billing": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Configuration for this specific subscription billing. Only available when the Billing API is enabled.",
                    "properties": {
                      "discount": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "description": "Discount to apply to the subscription.",
                        "properties": {
                          "voucher": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "The unique identifier for the existing [voucher](https://developers.gigs.com/api/latest/billing/vouchers) of the subscription. A voucher applies a discount to the price of a subscription.",
                            "examples": [
                              "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                            ]
                          }
                        }
                      },
                      "invoiceGracePeriodDays": {
                        "type": [
                          "integer",
                          "null"
                        ],
                        "description": "Number of days after renewal that an invoice can remain unpaid before it becomes overdue. After this period, the action specified in `invoiceOverdueAction` is triggered.\n\nWhen configured, this property takes precedence over the value set at the project level.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                        "examples": [
                          3
                        ]
                      },
                      "invoiceOverduePeriodDays": {
                        "type": [
                          "integer",
                          "null"
                        ],
                        "description": "Number of days that invoices can remain overdue before subscriptions are ended.\n\nRelevant when subscriptions are not ended immediately after an invoice becomes overdue.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                        "examples": [
                          1
                        ]
                      },
                      "invoiceOverdueAction": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          "end",
                          "none",
                          "restrict"
                        ],
                        "description": "Indicates what happens to the subscription when a renewal invoice becomes overdue. One of:\n\n- `none`: Leave the subscription as is.\n- `end`: End the subscription immediately.\n\nWhen configured, this property takes precedence over the value set at the project level.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
                      },
                      "restrictBehavior": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          null,
                          "incomingOnly",
                          "noData",
                          "throttledData"
                        ],
                        "description": "Required when `invoiceOverdueAction` is `restrict`.\nDetermines how subscriptions are restricted when an invoice becomes overdue. It can have one of the following values:\n\n- `incomingOnly`: The subscription line can receive calls & SMS, but cannot make calls, send SMS, or use data.\n- `noData`: The subscription line can make and receive calls & SMS, but cannot use data.\n- `throttledData`: The subscription line can still make and receive calls & SMS, and use up to 1GB of data at a reduced speed.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
                      },
                      "restoreBehavior": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          null,
                          "keepPeriodAnchor",
                          "resetPeriodAnchor"
                        ],
                        "description": "Required when `invoiceOverdueAction` is `restrict`.\nDetermines how subscriptions are restored once a subscription is restored (e.g. after payment of an overdue invoice). It can have one of the following values:\n\n- `resetPeriodAnchor`: The subscription cycle is reset to the date of restoration. This means the user has a whole new period to use their plan allowance that was just restored.\n- `keepPeriodAnchor`: The subscription cycle remains unchanged. The next renewal date stays the same as before the restriction.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
                      }
                    }
                  },
                  "device": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the existing [device](https://developers.gigs.com/core/devices#the-device-resource) to be linked with the passed SIM. Some network providers require this field (or `deviceModel`) for activation. If the exact IMEI of the device is known, then it is recommended to create a device and specify its ID here. See `deviceModel` if the device IMEI is not known. At most one of `device` and `deviceModel` may be specified. Trying to link a pSIM to a second device will cause an error.",
                    "examples": [
                      "dev_0SNlurA049MEWV55CrA9qMvI2FVJ"
                    ]
                  },
                  "deviceModel": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the [device model](https://developers.gigs.com/core/devices#retrieve-a-device-model) to be linked with the passed SIM. Some network providers require this field (or `device`) for activation. If the device IMEI is not known, but the device model is known, this property can be used in place of `device`. At most one of `device` and `deviceModel` may be specified.",
                    "examples": [
                      "dmd_0SNlurA04OUskUGfGAn3Rh"
                    ]
                  },
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  },
                  "fromSubscription": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for an existing ended [subscription](https://developers.gigs.com/core/subscriptions#the-subscription-resource) to base the new subscription on. The referenced subscription must have status `ended` and its SIM must still be usable (not retired, not ported out). When provided, the user, plan, SIM, billing settings, and applicable discounts are copied from the referenced subscription. This is the recommended way to reactivate an ended subscription and keep its phone number. An eSIM whose profile was deleted from the device can still be reused this way. If the original eSIM can't be installed on the phone anymore, follow up with a [subscription change](https://developers.gigs.com/core/subscription-changes#the-subscription-change-resource) to issue a new one. Cannot be combined with `user`, `plan`, `sim`, `porting`, `device`, `deviceModel`, `userAddress`, or `billing`."
                  },
                  "plan": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the existing [plan](https://developers.gigs.com/core/plans#the-plan-resource) to be used for the subscription. Required if `fromSubscription` is not provided.",
                    "examples": [
                      "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                    ]
                  },
                  "porting": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the existing draft [porting](https://developers.gigs.com/core/portings#the-porting-resource) to be used for the subscription.",
                    "examples": [
                      "prt_0SNlurA049MEWV39s2kSYqaat7ZS"
                    ]
                  },
                  "sim": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "default": "auto",
                    "description": "The unique identifier for the existing [SIM](https://developers.gigs.com/core/sims#the-sim-resource) to be used for the subscription. In combination with an eSIM plan, it can be passed as `auto` to request a new eSIM, or `preferLastUsed` to reuse the user's most recently used SIM from an ended subscription. `preferLastUsed` falls back to `auto` if no eligible SIM is found, which only works for eSIM-capable plans; for plans requiring a physical SIM, subscription creation will fail if no eligible SIM is found.",
                    "examples": [
                      "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                    ]
                  },
                  "userAddress": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the existing [user address](https://developers.gigs.com/core/user-addresses#the-user-address-resource) to be used for the subscription. Only needed if the plan requires an address.",
                    "examples": [
                      "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
                    ]
                  },
                  "user": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the existing [user](https://developers.gigs.com/core/users#the-user-resource) to which the subscription will be assigned. Required if `fromSubscription` is not provided.",
                    "examples": [
                      "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    ]
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "billing": {
                      "discount": {
                        "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                      },
                      "invoiceGracePeriodDays": 3,
                      "invoiceOverduePeriodDays": 1,
                      "invoiceOverdueAction": "end"
                    },
                    "device": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                    "deviceModel": "dmd_0SNlurA04OUskUGfGAn3Rh",
                    "metadata": {},
                    "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                    "porting": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                    "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                    "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the newly created subscription and supporting objects.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptions/{subscription}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscription",
          "in": "path",
          "description": "The unique identifier for the subscription.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsRetrieve",
        "summary": "Retrieve a subscription",
        "description": "Retrieves the details of an existing subscription. You need only supply the unique subscription identifier that was returned upon purchasing a plan.",
        "responses": {
          "200": {
            "description": "Returns the subscription if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "patch": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsUpdate",
        "summary": "Update a subscription",
        "description": "Updates the specified subscription by setting the values of the parameters passed.",
        "requestBody": {
          "description": "Optional parameters to be passed in the request body to update an existing subscription.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  },
                  "billing": {
                    "type": [
                      "object"
                    ],
                    "description": "Configuration for this specific subscription billing. Only available when the Billing API is enabled.",
                    "properties": {
                      "discount": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "description": "Discount to apply to the subscription. Using a `null` value will remove any existing discount.",
                        "properties": {
                          "voucher": {
                            "type": "string",
                            "description": "The unique identifier for the existing [voucher](https://developers.gigs.com/api/latest/billing/vouchers) of the subscription. A voucher applies a discount to the price of a subscription.",
                            "examples": [
                              "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                            ]
                          }
                        }
                      },
                      "invoiceGracePeriodDays": {
                        "type": [
                          "integer",
                          "null"
                        ],
                        "description": "Number of days after renewal that an invoice can remain unpaid before it becomes overdue. After this period, the action specified in `invoiceOverdueAction` is triggered.\n\nWhen configured, this property takes precedence over the value set at the project level.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                        "examples": [
                          3
                        ]
                      },
                      "invoiceOverduePeriodDays": {
                        "type": [
                          "integer",
                          "null"
                        ],
                        "description": "Number of days that invoices can remain overdue before subscriptions are ended.\n\nRelevant when subscriptions are not ended immediately after an invoice becomes overdue.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                        "examples": [
                          1
                        ]
                      },
                      "invoiceOverdueAction": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          "end",
                          "none",
                          "restrict"
                        ],
                        "description": "Indicates what happens to the subscription when a renewal invoice becomes overdue. One of:\n\n- `none`: Leave the subscription as is.\n- `end`: End the subscription immediately.\n- `restrict`: Restrict the subscription's connectivity.\n\nWhen configured, this property takes precedence over the value set at the project level.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
                      },
                      "restrictBehavior": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          null,
                          "incomingOnly",
                          "noData",
                          "throttledData"
                        ],
                        "description": "Required when `invoiceOverdueAction` is `restrict`.\nDetermines how subscriptions are restricted when an invoice becomes overdue. It can have one of the following values:\n\n- `incomingOnly`: The subscription line can receive calls & SMS, but cannot make calls, send SMS, or use data.\n- `noData`: The subscription line can make and receive calls & SMS, but cannot use data.\n- `throttledData`: The subscription line can still make and receive calls & SMS, and use up to 1GB of data at a reduced speed.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
                      },
                      "restoreBehavior": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          null,
                          "keepPeriodAnchor",
                          "resetPeriodAnchor"
                        ],
                        "description": "Required when `invoiceOverdueAction` is `restrict`.\nDetermines how subscriptions are restored once a subscription is restored (e.g. after payment of an overdue invoice). It can have one of the following values:\n\n- `resetPeriodAnchor`: The subscription cycle is reset to the date of restoration. This means the user has a whole new period to use their plan allowance that was just restored.\n- `keepPeriodAnchor`: The subscription cycle remains unchanged. The next renewal date stays the same as before the restriction.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
                      }
                    }
                  },
                  "userAddress": {
                    "type": "string",
                    "description": "The unique identifier for an existing [user address](https://developers.gigs.com/core/user-addresses#the-user-address-resource) to be used for the subscription.\n\nOnce a subscription has a user address it cannot be removed, only updated to a different user address. Only available for active subscriptions.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "metadata": {},
                    "billing": {
                      "discount": {
                        "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                      },
                      "invoiceGracePeriodDays": 3,
                      "invoiceOverduePeriodDays": 1,
                      "invoiceOverdueAction": "end"
                    },
                    "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the updated subscription.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptions/{subscription}/cancel": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscription",
          "in": "path",
          "description": "The unique identifier for the subscription.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsCancel",
        "summary": "Cancel an active subscription",
        "description": "Cancels a subscription. A canceled subscription still has connectivity,\nbut is no longer renewed.\n\nA canceled subscription is ended at the end of its contract term (as\ndefined by its plan) or, if it is already past the term, at the end of\nits current period.\n\nNote that the status of a subscription that has been canceled will\nremain `active` until the `endedAt` date is reached, at which point it\nwill be updated to `ended`.\n\nA subscription can only be canceled up to one hour before its renewal.\nIf it is canceled after this point, it will be ended after the\nfollowing period.\n\nA canceled subscription that hasn't yet ended can be [resumed](https://developers.gigs.com/core/subscriptions#resume-a-canceled-subscription).\n\nNote: Cancellation is rejected when the subscription might never\nactivate on its own, e.g. the porting has not been submitted to\nthe provider yet. Use the\n[end endpoint](https://developers.gigs.com/core/subscriptions#end-a-subscription)\ninstead to immediately terminate the subscription.\n",
        "requestBody": {
          "description": "Optional and required parameters to be passed in the request body to cancel a subscription.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "cancellationDetails": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Details about the cancellation of the subscription.",
                    "properties": {
                      "userComment": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Comment from the user explaining the cancellation reason. It is only present when the userReason is other."
                      },
                      "userReason": {
                        "type": "string",
                        "enum": [
                          "connectivityIssues",
                          "customerService",
                          "noDetails",
                          "other",
                          "tooExpensive",
                          "unused"
                        ],
                        "description": "Reason for the user to cancel the subscription."
                      }
                    },
                    "required": [
                      "userReason"
                    ]
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "cancellationDetails": {
                      "userReason": "connectivityIssues"
                    }
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "description": "Returns the subscription after a successful cancellation.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptions/{subscription}/portIn": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscription",
          "in": "path",
          "description": "The unique identifier for the subscription.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsPortin",
        "summary": "Port a phone number into a subscription",
        "description": "Port a phone number into an active subscription.\n\nThe subscription remains activated and connected to the old phone number until the porting is completed.\nAfter the porting is completed, the phone number of this subscription is updated.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "parameters": [],
        "requestBody": {
          "description": "The parameters to request a mid-subscription porting.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "porting": {
                    "type": "string",
                    "description": "The unique identifier for the existing draft [porting](https://developers.gigs.com/core/portings#the-porting-resource) to be requested for this subscription.",
                    "examples": [
                      "prt_0SNlurA049MEWV39s2kSYqaat7ZS"
                    ]
                  }
                },
                "required": [
                  "porting"
                ]
              },
              "examples": {
                "Example": {
                  "summary": "Example",
                  "value": {
                    "porting": "prt_0SNlurA049MEWV39s2kSYqaat7ZS"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the subscription after successfully requesting the port in.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptions/{subscription}/end": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscription",
          "in": "path",
          "description": "The unique identifier for the subscription.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsEnd",
        "summary": "End a subscription immediately",
        "description": "Ends a subscriptions immediately given its identifier.\n\nAdditionally, you can pass in optional cancellation details in the\nrequest body, which will be used to provide more context on why the\nsubscription was ended.\n",
        "requestBody": {
          "description": "Optional and required parameters to be passed in the request body to end a subscription.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "cancellationDetails": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Details about the cancellation of the subscription.",
                    "properties": {
                      "userComment": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Comment from the user explaining the cancellation reason. It is only present when the userReason is other."
                      },
                      "userReason": {
                        "type": "string",
                        "enum": [
                          "connectivityIssues",
                          "customerService",
                          "noDetails",
                          "other",
                          "tooExpensive",
                          "unused"
                        ],
                        "description": "Reason for the user to cancel the subscription."
                      }
                    },
                    "required": [
                      "userReason"
                    ]
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "cancellationDetails": {
                      "userReason": "connectivityIssues"
                    }
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "description": "Returns the ended subscription after a successful termination.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptions/{subscription}/resume": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscription",
          "in": "path",
          "description": "The unique identifier for the subscription.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsResume",
        "summary": "Resume a canceled subscription",
        "description": "Removes the cancellation and end times of the subscription. The subscription will continue to auto-renew until canceled again.",
        "responses": {
          "200": {
            "description": "Returns the resumed subscription.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptions/search": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "SubscriptionsSearch",
        "summary": "Search for subscriptions",
        "description": "Searches for existing subscriptions matching the given parameters.",
        "requestBody": {
          "description": "Subscription attributes to search for.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "phoneNumber": {
                    "type": "string",
                    "format": "E.164",
                    "description": "The E.164-formatted phone number associated with the subscription.",
                    "examples": [
                      "+12065550123"
                    ]
                  }
                },
                "required": [
                  "phoneNumber"
                ]
              },
              "examples": {
                "Example": {
                  "summary": "Example",
                  "value": {
                    "phoneNumber": "+12065550123"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns a list schema response with all found subscriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `subscription`.",
                      "items": {
                        "$ref": "#/components/schemas/subscription"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "subscription",
                          "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "metadata": {},
                          "activatedAt": "2021-01-21T19:38:34Z",
                          "billing": {
                            "discount": {
                              "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                              "expiresAt": "2021-02-20T19:38:34Z"
                            },
                            "invoiceGracePeriodDays": 3,
                            "invoiceOverduePeriodDays": 1,
                            "invoiceOverdueAction": null,
                            "restrictBehavior": null,
                            "restoreBehavior": null
                          },
                          "canceledAt": "2021-01-29T13:22:51Z",
                          "cancellationDetails": {
                            "cause": "cancellationRequested",
                            "userReason": "connectivityIssues"
                          },
                          "createdAt": "2021-01-21T19:32:13Z",
                          "currentPeriod": {
                            "number": 1,
                            "start": "2021-01-21T19:32:13Z",
                            "end": "2021-02-20T19:38:34Z"
                          },
                          "earliestEndAt": "2021-02-20T19:38:34Z",
                          "endedAt": "2021-02-20T19:38:34Z",
                          "firstUsageAt": "2021-01-21T19:38:34Z",
                          "lastPorting": {
                            "object": "porting",
                            "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                            "accountNumber": "123456789",
                            "accountPinExists": true,
                            "accountType": "prepaidUnregistered",
                            "address": {
                              "city": "New York City",
                              "country": "US",
                              "line1": "129 West 81st Street",
                              "line2": "Apartment 5",
                              "postalCode": "10024",
                              "state": "NY"
                            },
                            "behavior": "portIn",
                            "billingPinExists": true,
                            "birthday": "2017-07-21",
                            "canceledAt": "2021-01-21T19:39:53Z",
                            "completedAt": "2021-01-21T19:36:57Z",
                            "createdAt": "2021-01-21T19:12:28Z",
                            "declinedAttempts": 0,
                            "declinedCode": "portingPhoneNumberPortProtected",
                            "declinedMessage": "The phone number has port protection on the provider.",
                            "donorProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "donorProviderApproval": true,
                            "expiredAt": "2021-01-21T19:39:53Z",
                            "failedAt": "2021-01-21T19:39:53Z",
                            "failureReason": "consentNotGiven",
                            "firstName": "Jerry",
                            "lastDeclinedAt": "2021-01-21T19:31:13Z",
                            "lastName": "Seinfeld",
                            "lastRequestedAt": "2021-01-21T19:22:31Z",
                            "phoneNumber": "+19591234567",
                            "provider": "p9",
                            "recipientProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "requestBehavior": "automatic",
                            "required": [
                              "accountNumber",
                              "accountPin",
                              "accountType",
                              "address",
                              "birthday",
                              "donorProvider",
                              "donorProviderApproval",
                              "firstName",
                              "lastName"
                            ],
                            "scheduledOn": "2021-01-21",
                            "status": "draft",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                          },
                          "phoneNumber": "+19591234567",
                          "plan": {
                            "object": "plan",
                            "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                            "metadata": {},
                            "activationTrigger": "creation",
                            "allowances": {
                              "dataBytes": 10000000000,
                              "voiceSeconds": 30000,
                              "smsMessages": 100
                            },
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "createdAt": "2021-01-21T19:38:34Z",
                            "description": "A data plan you will love! Operates in most countries of the world.",
                            "firstPeriodTrigger": "creation",
                            "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                            "limits": {
                              "dataBytes": 100000000000,
                              "bandwidthBitsPerSecond": 100000000,
                              "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"
                            ],
                            "status": "available",
                            "validity": {
                              "minimumPeriods": 12,
                              "type": "recurring",
                              "unit": "day",
                              "value": 7
                            },
                            "data": 10000000000,
                            "dataUnit": "byte",
                            "sms": 100,
                            "smsUnit": "message",
                            "voice": 30000,
                            "voiceUnit": "second"
                          },
                          "restoreRequestedAt": "2021-02-21T19:38:34Z",
                          "restrictedAt": "2021-02-21T19:38:34Z",
                          "restrictionDetails": {
                            "restrictBehavior": "incomingOnly",
                            "restoreBehavior": "resetPeriodAnchor",
                            "cause": "invoiceOverdue"
                          },
                          "sim": {
                            "object": "sim",
                            "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                            "metadata": {},
                            "createdAt": "2021-01-21T19:38:34Z",
                            "iccid": "89883070000007537119",
                            "provider": "p9",
                            "status": "inactive",
                            "suspension": null,
                            "type": "eSIM"
                          },
                          "status": "pending",
                          "user": {
                            "object": "user",
                            "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                            "metadata": {},
                            "birthday": "2017-07-21",
                            "createdAt": "2021-01-21T19:38:34Z",
                            "email": "jerry@example.com",
                            "emailVerified": true,
                            "fullName": "Jerry Seinfeld",
                            "preferredLocale": "en-US",
                            "status": "active"
                          },
                          "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                          "porting": {
                            "object": "porting",
                            "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                            "accountNumber": "123456789",
                            "accountPinExists": true,
                            "accountType": "prepaidUnregistered",
                            "address": {
                              "city": "New York City",
                              "country": "US",
                              "line1": "129 West 81st Street",
                              "line2": "Apartment 5",
                              "postalCode": "10024",
                              "state": "NY"
                            },
                            "behavior": "portIn",
                            "billingPinExists": true,
                            "birthday": "2017-07-21",
                            "canceledAt": "2021-01-21T19:39:53Z",
                            "completedAt": "2021-01-21T19:36:57Z",
                            "createdAt": "2021-01-21T19:12:28Z",
                            "declinedAttempts": 0,
                            "declinedCode": "portingPhoneNumberPortProtected",
                            "declinedMessage": "The phone number has port protection on the provider.",
                            "donorProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "donorProviderApproval": true,
                            "expiredAt": "2021-01-21T19:39:53Z",
                            "failedAt": "2021-01-21T19:39:53Z",
                            "failureReason": "consentNotGiven",
                            "firstName": "Jerry",
                            "lastDeclinedAt": "2021-01-21T19:31:13Z",
                            "lastName": "Seinfeld",
                            "lastRequestedAt": "2021-01-21T19:22:31Z",
                            "phoneNumber": "+19591234567",
                            "provider": "p9",
                            "recipientProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "requestBehavior": "automatic",
                            "required": [
                              "accountNumber",
                              "accountPin",
                              "accountType",
                              "address",
                              "birthday",
                              "donorProvider",
                              "donorProviderApproval",
                              "firstName",
                              "lastName"
                            ],
                            "scheduledOn": "2021-01-21",
                            "status": "draft",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                          }
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "subscription",
                          "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "metadata": {},
                          "activatedAt": "2021-01-21T19:38:34Z",
                          "billing": {
                            "discount": {
                              "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                              "expiresAt": "2021-02-20T19:38:34Z"
                            },
                            "invoiceGracePeriodDays": 3,
                            "invoiceOverduePeriodDays": 1,
                            "invoiceOverdueAction": null,
                            "restrictBehavior": null,
                            "restoreBehavior": null
                          },
                          "canceledAt": "2021-01-29T13:22:51Z",
                          "cancellationDetails": {},
                          "createdAt": "2021-01-21T19:32:13Z",
                          "currentPeriod": {
                            "number": 1,
                            "start": "2021-01-21T19:32:13Z",
                            "end": "2021-02-20T19:38:34Z"
                          },
                          "earliestEndAt": "2021-02-20T19:38:34Z",
                          "endedAt": "2021-02-20T19:38:34Z",
                          "firstUsageAt": "2021-01-21T19:38:34Z",
                          "lastPorting": {
                            "object": "porting",
                            "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                            "accountNumber": "123456789",
                            "accountPinExists": true,
                            "accountType": "prepaidUnregistered",
                            "address": {
                              "city": "New York City",
                              "country": "US",
                              "line1": "129 West 81st Street",
                              "line2": "Apartment 5",
                              "postalCode": "10024",
                              "state": "NY"
                            },
                            "behavior": "portIn",
                            "billingPinExists": true,
                            "birthday": "2017-07-21",
                            "canceledAt": "2021-01-21T19:39:53Z",
                            "completedAt": "2021-01-21T19:36:57Z",
                            "createdAt": "2021-01-21T19:12:28Z",
                            "declinedAttempts": 0,
                            "declinedCode": "portingPhoneNumberPortProtected",
                            "declinedMessage": "The phone number has port protection on the provider.",
                            "donorProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "donorProviderApproval": true,
                            "expiredAt": "2021-01-21T19:39:53Z",
                            "failedAt": "2021-01-21T19:39:53Z",
                            "failureReason": "consentNotGiven",
                            "firstName": "Jerry",
                            "lastDeclinedAt": "2021-01-21T19:31:13Z",
                            "lastName": "Seinfeld",
                            "lastRequestedAt": "2021-01-21T19:22:31Z",
                            "phoneNumber": "+19591234567",
                            "provider": "p9",
                            "recipientProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "requestBehavior": "automatic",
                            "required": [
                              "accountNumber",
                              "accountPin",
                              "accountType",
                              "address",
                              "birthday",
                              "donorProvider",
                              "donorProviderApproval",
                              "firstName",
                              "lastName"
                            ],
                            "scheduledOn": "2021-01-21",
                            "status": "draft",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                          },
                          "phoneNumber": "+19591234567",
                          "plan": {
                            "object": "plan",
                            "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                            "metadata": {},
                            "activationTrigger": "creation",
                            "allowances": {
                              "dataBytes": 10000000000,
                              "voiceSeconds": 30000,
                              "smsMessages": 100
                            },
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "createdAt": "2021-01-21T19:38:34Z",
                            "description": "A data plan you will love! Operates in most countries of the world.",
                            "firstPeriodTrigger": "creation",
                            "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                            "limits": {
                              "dataBytes": 100000000000,
                              "bandwidthBitsPerSecond": 100000000,
                              "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"
                            ],
                            "status": "available",
                            "validity": {
                              "minimumPeriods": 12,
                              "type": "recurring",
                              "unit": "day",
                              "value": 7
                            },
                            "data": 10000000000,
                            "dataUnit": "byte",
                            "sms": 100,
                            "smsUnit": "message",
                            "voice": 30000,
                            "voiceUnit": "second"
                          },
                          "restoreRequestedAt": "2021-02-21T19:38:34Z",
                          "restrictedAt": "2021-02-21T19:38:34Z",
                          "restrictionDetails": {
                            "restrictBehavior": "incomingOnly",
                            "restoreBehavior": "resetPeriodAnchor",
                            "cause": "invoiceOverdue"
                          },
                          "sim": {
                            "object": "sim",
                            "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                            "metadata": {},
                            "createdAt": "2021-01-21T19:38:34Z",
                            "iccid": "89883070000007537119",
                            "provider": "p9",
                            "status": "inactive",
                            "suspension": null,
                            "type": "eSIM"
                          },
                          "status": "pending",
                          "user": {
                            "object": "user",
                            "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                            "metadata": {},
                            "birthday": "2017-07-21",
                            "createdAt": "2021-01-21T19:38:34Z",
                            "email": "jerry@example.com",
                            "emailVerified": true,
                            "fullName": "Jerry Seinfeld",
                            "preferredLocale": "en-US",
                            "status": "active"
                          },
                          "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                          "porting": {
                            "object": "porting",
                            "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                            "accountNumber": "123456789",
                            "accountPinExists": true,
                            "accountType": "prepaidUnregistered",
                            "address": {
                              "city": "New York City",
                              "country": "US",
                              "line1": "129 West 81st Street",
                              "line2": "Apartment 5",
                              "postalCode": "10024",
                              "state": "NY"
                            },
                            "behavior": "portIn",
                            "billingPinExists": true,
                            "birthday": "2017-07-21",
                            "canceledAt": "2021-01-21T19:39:53Z",
                            "completedAt": "2021-01-21T19:36:57Z",
                            "createdAt": "2021-01-21T19:12:28Z",
                            "declinedAttempts": 0,
                            "declinedCode": "portingPhoneNumberPortProtected",
                            "declinedMessage": "The phone number has port protection on the provider.",
                            "donorProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "donorProviderApproval": true,
                            "expiredAt": "2021-01-21T19:39:53Z",
                            "failedAt": "2021-01-21T19:39:53Z",
                            "failureReason": "consentNotGiven",
                            "firstName": "Jerry",
                            "lastDeclinedAt": "2021-01-21T19:31:13Z",
                            "lastName": "Seinfeld",
                            "lastRequestedAt": "2021-01-21T19:22:31Z",
                            "phoneNumber": "+19591234567",
                            "provider": "p9",
                            "recipientProvider": {
                              "object": "serviceProvider",
                              "id": "svp_0SNlurA01K6GY5L0XJffY8",
                              "country": "US",
                              "name": "AT&T",
                              "recipientProviders": [
                                "p3"
                              ]
                            },
                            "requestBehavior": "automatic",
                            "required": [
                              "accountNumber",
                              "accountPin",
                              "accountType",
                              "address",
                              "birthday",
                              "donorProvider",
                              "donorProviderApproval",
                              "firstName",
                              "lastName"
                            ],
                            "scheduledOn": "2021-01-21",
                            "status": "draft",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                          }
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptionAddons": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "SubscriptionAddonsList",
        "summary": "List all subscription add-ons",
        "description": "Returns a list of subscription add-ons. The subscription add-ons returned are sorted by creation date, with the most recently created subscription add-ons appearing first.",
        "parameters": [
          {
            "name": "addon",
            "in": "query",
            "description": "The unique identifier for the add-on to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "A comma-separated list of statuses to filter the subscription add-ons by.",
            "schema": {
              "type": "array",
              "default": [
                "pending",
                "initiated",
                "active"
              ],
              "items": {
                "type": "string",
                "enum": [
                  "pending",
                  "initiated",
                  "active",
                  "ended"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "subscription",
            "in": "query",
            "description": "The unique identifier for the subscription to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
              ]
            }
          },
          {
            "name": "user",
            "in": "query",
            "description": "The unique identifier for the user to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of subscription add-ons.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `subscriptionAddon`.",
                      "items": {
                        "$ref": "#/components/schemas/subscriptionAddon"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "subscriptionAddon",
                          "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "activatedAt": "2021-01-15T12:36:57Z",
                          "addon": {
                            "object": "addon",
                            "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                            "metadata": {},
                            "activationTrigger": "creation",
                            "allowances": {
                              "dataBytes": 10000000000,
                              "voiceSeconds": 30000,
                              "smsMessages": 100
                            },
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "createdAt": "2021-01-21T19:12:28Z",
                            "description": "Disable international roaming.",
                            "limits": {
                              "dataBytes": 13000000000,
                              "throttling": {
                                "thresholdBytes": 3000000000,
                                "bandwidthBitsPerSecond": 256000
                              }
                            },
                            "name": "1GB Data Top-up",
                            "plans": [
                              "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                            ],
                            "price": {
                              "amount": 999,
                              "currency": "USD"
                            },
                            "provider": "p5",
                            "recurrenceType": "oneTime",
                            "status": "draft",
                            "type": "topUp",
                            "validity": {
                              "unit": "day",
                              "value": 7,
                              "totalPeriods": 1
                            },
                            "data": 10000000000,
                            "dataUnit": "byte",
                            "sms": 100,
                            "smsUnit": "message",
                            "voice": 30000,
                            "voiceUnit": "second"
                          },
                          "billing": {
                            "discount": {
                              "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                              "expiresAt": "2021-02-20T19:38:34Z"
                            }
                          },
                          "canceledAt": "2021-01-22T19:39:53Z",
                          "createdAt": "2021-01-15T12:30:28Z",
                          "currentPeriod": {
                            "number": 1,
                            "start": "2021-01-21T19:32:13Z",
                            "end": "2021-02-20T19:38:34Z"
                          },
                          "endedAt": "2021-01-30T23:12:28Z",
                          "status": "pending",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "subscriptionAddon",
                          "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "activatedAt": "2021-01-15T12:36:57Z",
                          "addon": {
                            "object": "addon",
                            "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                            "metadata": {},
                            "activationTrigger": "creation",
                            "allowances": {
                              "dataBytes": 10000000000,
                              "voiceSeconds": 30000,
                              "smsMessages": 100
                            },
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "createdAt": "2021-01-21T19:12:28Z",
                            "description": "Disable international roaming.",
                            "limits": {
                              "dataBytes": 13000000000,
                              "throttling": {
                                "thresholdBytes": 3000000000,
                                "bandwidthBitsPerSecond": 256000
                              }
                            },
                            "name": "1GB Data Top-up",
                            "plans": [
                              "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                            ],
                            "price": {
                              "amount": 999,
                              "currency": "USD"
                            },
                            "provider": "p5",
                            "recurrenceType": "oneTime",
                            "status": "draft",
                            "type": "topUp",
                            "validity": {
                              "unit": "day",
                              "value": 7
                            },
                            "data": 10000000000,
                            "dataUnit": "byte",
                            "sms": 100,
                            "smsUnit": "message",
                            "voice": 30000,
                            "voiceUnit": "second"
                          },
                          "billing": {
                            "discount": {
                              "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                              "expiresAt": "2021-02-20T19:38:34Z"
                            }
                          },
                          "canceledAt": "2021-01-22T19:39:53Z",
                          "createdAt": "2021-01-15T12:30:28Z",
                          "currentPeriod": {
                            "number": 1,
                            "start": "2021-01-21T19:32:13Z",
                            "end": "2021-02-20T19:38:34Z"
                          },
                          "endedAt": "2021-01-30T23:12:28Z",
                          "status": "pending",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "post": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "SubscriptionAddonsCreate",
        "summary": "Create a subscription add-on",
        "description": "Creates a new subscription add-on for an existing subscription in the specified project.\n\nOn projects with billing enabled, the subscription may still be activating (status `initiated` or `pending`). The add-on is invoiced right away and activates once its invoice is paid and the subscription is active.\n",
        "requestBody": {
          "description": "Required parameters to be passed in the request body to create a new subscription add-on.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "addon": {
                    "type": "string",
                    "description": "Unique identifier of the add-on.",
                    "examples": [
                      "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
                    ]
                  },
                  "billing": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Configuration for this specific subscription add-on billing. Only available when the Billing API is enabled.",
                    "properties": {
                      "discount": {
                        "type": [
                          "object",
                          "null"
                        ],
                        "description": "Discount to apply to the subscription add-on.",
                        "properties": {
                          "voucher": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "The unique identifier for the existing [voucher](https://developers.gigs.com/api/latest/billing/vouchers) of the subscription add-on. A voucher applies a discount to the price of a subscription add-on.",
                            "examples": [
                              "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                            ]
                          }
                        }
                      },
                      "paymentBehavior": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          "manual",
                          "none"
                        ],
                        "description": "Determines how invoices are paid for this subscription add-on. It can have one of the following values:\n\n- `manual`: Invoices are not automatically paid without explicit action.\n- `none`: No payment is performed and invoices are marked as paid automatically.\n\nWhen configured, this property takes precedence over the value set at the project level.\n",
                        "examples": [
                          "manual"
                        ]
                      }
                    }
                  },
                  "subscription": {
                    "type": [
                      "string"
                    ],
                    "description": "Unique identifier of the subscription the add-on applies to.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "addon",
                  "subscription"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                    "billing": {
                      "discount": {
                        "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                      },
                      "paymentBehavior": "manual"
                    },
                    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the newly created subscription add-on.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscriptionAddon"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7,
                          "totalPeriods": 1
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptionAddons/{subscriptionAddon}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscriptionAddon",
          "in": "path",
          "description": "The unique identifier for the subscription add-on.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "SubscriptionAddonsRetrieve",
        "summary": "Retrieve a subscription add-on",
        "description": "Retrieve the details of an existing subscription add-on which the authenticated user is authorized to view.",
        "responses": {
          "200": {
            "description": "Returns the subscription add-on if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscriptionAddon"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7,
                          "totalPeriods": 1
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "delete": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "SubscriptionAddonsEnd",
        "summary": "End a subscription add-on",
        "description": "Ends a subscription add-on immediately. Subscription add-ons that are already ended cannot be ended again.",
        "responses": {
          "200": {
            "description": "Returns the ended subscription add-on.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscriptionAddon"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7,
                          "totalPeriods": 1
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptionChanges": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "SubscriptionChangesList",
        "summary": "List all subscription changes",
        "description": "Returns a list of subscription changes. The subscription changes returned are sorted by creation date, with the most recently created subscription changes appearing first.",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "A comma-separated list of statuses to filter the subscription changes by.",
            "schema": {
              "type": "array",
              "default": [
                "pending",
                "initiated"
              ],
              "items": {
                "type": "string",
                "enum": [
                  "pending",
                  "initiated",
                  "applied",
                  "failed",
                  "deleted"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "subscription",
            "in": "query",
            "description": "The unique identifier for the subscription to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
              ]
            }
          },
          {
            "name": "user",
            "in": "query",
            "description": "The unique identifier for the user to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of subscription changes.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `subscriptionChange`.",
                      "items": {
                        "$ref": "#/components/schemas/subscriptionChange"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "subscriptionChange",
                          "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "appliedAt": "2021-01-21T19:36:57Z",
                          "createdAt": "2021-01-21T19:12:28Z",
                          "failureCode": "consentNotGiven",
                          "plan": {
                            "object": "plan",
                            "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                            "metadata": {},
                            "activationTrigger": "creation",
                            "allowances": {
                              "dataBytes": 10000000000,
                              "voiceSeconds": 30000,
                              "smsMessages": 100
                            },
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "createdAt": "2021-01-21T19:38:34Z",
                            "description": "A data plan you will love! Operates in most countries of the world.",
                            "firstPeriodTrigger": "creation",
                            "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                            "limits": {
                              "dataBytes": 100000000000,
                              "bandwidthBitsPerSecond": 100000000,
                              "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"
                            ],
                            "status": "available",
                            "validity": {
                              "minimumPeriods": 12,
                              "type": "recurring",
                              "unit": "day",
                              "value": 7
                            },
                            "data": 10000000000,
                            "dataUnit": "byte",
                            "sms": 100,
                            "smsUnit": "message",
                            "voice": 30000,
                            "voiceUnit": "second"
                          },
                          "requestedChange": {
                            "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                            "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                            "phoneNumber": "auto",
                            "when": "renewal"
                          },
                          "scheduledAt": "2021-01-21T19:12:28Z",
                          "sim": {
                            "object": "sim",
                            "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                            "metadata": {},
                            "createdAt": "2021-01-21T19:38:34Z",
                            "iccid": "89883070000007537119",
                            "provider": "p9",
                            "status": "inactive",
                            "suspension": null,
                            "type": "eSIM"
                          },
                          "status": "pending",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "subscriptionChange",
                          "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "appliedAt": "2021-01-21T19:36:57Z",
                          "createdAt": "2021-01-21T19:12:28Z",
                          "failureCode": "consentNotGiven",
                          "plan": {
                            "object": "plan",
                            "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                            "metadata": {},
                            "activationTrigger": "creation",
                            "allowances": {
                              "dataBytes": 10000000000,
                              "voiceSeconds": 30000,
                              "smsMessages": 100
                            },
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "createdAt": "2021-01-21T19:38:34Z",
                            "description": "A data plan you will love! Operates in most countries of the world.",
                            "firstPeriodTrigger": "creation",
                            "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                            "limits": {
                              "dataBytes": 100000000000,
                              "bandwidthBitsPerSecond": 100000000,
                              "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"
                            ],
                            "status": "available",
                            "validity": {
                              "minimumPeriods": 12,
                              "type": "recurring",
                              "unit": "day",
                              "value": 7
                            },
                            "data": 10000000000,
                            "dataUnit": "byte",
                            "sms": 100,
                            "smsUnit": "message",
                            "voice": 30000,
                            "voiceUnit": "second"
                          },
                          "requestedChange": {
                            "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                            "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                            "phoneNumber": "auto",
                            "when": "renewal"
                          },
                          "scheduledAt": "2021-01-21T19:12:28Z",
                          "sim": {
                            "object": "sim",
                            "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                            "metadata": {},
                            "createdAt": "2021-01-21T19:38:34Z",
                            "iccid": "89883070000007537119",
                            "provider": "p9",
                            "status": "inactive",
                            "suspension": null,
                            "type": "eSIM"
                          },
                          "status": "pending",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "post": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "SubscriptionChangesCreate",
        "summary": "Create a subscription change",
        "description": "Creates a new subscription change for an existing subscription in the specified project.\n\nNote that plan changes cannot be created within the cutoff period of 1 hour before the subscription period ends. In the UK, this cutoff period is extended to 13 hours but only for changes scheduled at renewal.\n",
        "parameters": [],
        "requestBody": {
          "description": "Required parameters to be passed in the request body to create a new subscription change:",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "plan": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "Unique identifier of the target plan, to which the subscription should be changed.",
                    "examples": [
                      "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                    ]
                  },
                  "sim": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "Unique identifier of the target SIM, to which the subscription should be changed. Can also be set to \"auto\", in which case an eSIM will be automatically allocated.",
                    "examples": [
                      "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                    ]
                  },
                  "phoneNumber": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "Requests a change of the subscription's phone number. Only \"auto\" is supported: the network provider assigns a new random number. Mutually exclusive with `plan` and `sim`, and only valid with `when` set to \"now\". Changing the phone number is only available for a subset of network providers.",
                    "examples": [
                      "auto"
                    ]
                  },
                  "subscription": {
                    "type": "string",
                    "description": "Unique identifier of the subscription to be changed.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  },
                  "when": {
                    "type": "string",
                    "enum": [
                      "now",
                      "renewal"
                    ],
                    "default": "renewal",
                    "description": "When the change should take effect. If set to `\"now\"`, the change will take effect immediately. If set to `\"renewal\"`, the change will instead take effect at the next subscription renewal date. Plan changes can always happen on `\"renewal\"`, but only selected network providers allow `\"now\"` changes. SIM changes can only happen `\"now\"`.",
                    "examples": [
                      "renewal"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "examples": {
                "Plan change": {
                  "summary": "Plan change",
                  "value": {
                    "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                    "when": "renewal"
                  }
                },
                "SIM change": {
                  "summary": "SIM change",
                  "value": {
                    "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                    "when": "now"
                  }
                },
                "Phone number change": {
                  "summary": "Phone number change",
                  "value": {
                    "phoneNumber": "auto",
                    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                    "when": "now"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the newly created subscription change.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscriptionChange"
                },
                "examples": {
                  "Plan change": {
                    "summary": "Plan change",
                    "value": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": null,
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": null,
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": null,
                        "phoneNumber": null,
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": null,
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  },
                  "SIM change": {
                    "summary": "SIM change",
                    "value": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": null,
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": null,
                      "plan": null,
                      "requestedChange": {
                        "plan": null,
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": null,
                        "when": "now"
                      },
                      "scheduledAt": null,
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  },
                  "Phone number change": {
                    "summary": "Phone number change",
                    "value": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": null,
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": null,
                      "plan": null,
                      "requestedChange": {
                        "plan": null,
                        "sim": null,
                        "phoneNumber": "auto",
                        "when": "now"
                      },
                      "scheduledAt": null,
                      "sim": null,
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptionChanges/{subscriptionChange}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscriptionChange",
          "in": "path",
          "description": "The unique identifier for the subscription change.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sch_0SNlurA049MEWV3bE0SMtbIEJApp"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "SubscriptionChangesRetrieve",
        "summary": "Retrieve a subscription change",
        "description": "Retrieve the details of an existing subscription change which the authenticated user is authorized to view.",
        "responses": {
          "200": {
            "description": "Returns the subscription change if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscriptionChange"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "delete": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "SubscriptionChangesDelete",
        "summary": "Delete a subscription change",
        "description": "Retrieve the details of an existing subscription change and delete it. Only subscription changes that have not been applied can be deleted.",
        "responses": {
          "200": {
            "description": "Returns the subscription change after a successful deletion.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscriptionChange"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/subscriptions/{subscription}/usage": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscription",
          "in": "path",
          "description": "The unique identifier for the subscription.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Usage"
        ],
        "operationId": "SubscriptionUsageList",
        "summary": "List subscription usage records",
        "description": "Lists usage records in ascending order for a subscription, defaulting to `daily` aggregation for the latest subscription period. If none of the `start`, `end`, or `period` parameters is provided, records are returned for the latest subscription period.",
        "parameters": [
          {
            "name": "period",
            "in": "query",
            "description": "Limits the usage data returned to the subscription period provided. This option is incompatible with the `start` and `end` parameters.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "examples": [
                12
              ]
            }
          },
          {
            "name": "start",
            "in": "query",
            "description": "Limits the usage data to dates greater than or equal to the provided date. Can only be used in combination with `end`.",
            "schema": {
              "type": "string",
              "format": "date",
              "examples": [
                "2021-06-19"
              ]
            }
          },
          {
            "name": "end",
            "in": "query",
            "description": "Limits the usage data to dates up to and including the provided date. Can only be used in combination with `start`.",
            "schema": {
              "type": "string",
              "format": "date",
              "examples": [
                "2021-11-14"
              ]
            }
          },
          {
            "name": "aggregation",
            "in": "query",
            "description": "Determines the aggregation method used, defaulting to `daily`. `period` provides aggregated values for the time range or period requested. The `roaming` aggregation is in preview and may only be used in particular cases.",
            "schema": {
              "type": "string",
              "enum": [
                "daily",
                "period",
                "country",
                "roaming",
                "daily,country",
                "daily,roaming",
                "period,country",
                "period,roaming",
                "country,daily",
                "country,period",
                "roaming,daily",
                "roaming,period"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the list of usage records.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `usageRecord`.",
                      "items": {
                        "$ref": "#/components/schemas/usageRecord"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "usageRecord",
                          "data": 18883100,
                          "dataDeviceBytes": 30029300,
                          "dataTetheringBytes": 30029300,
                          "end": "2021-02-15T00:00:00Z",
                          "labels": {
                            "country": "US",
                            "roaming": "none",
                            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                          },
                          "sms": 15,
                          "smsInternationalMessages": 6,
                          "smsLocalMessages": 6,
                          "start": "2021-02-14T00:00:00Z",
                          "updatedAt": "2024-02-15T12:13:14Z",
                          "voice": 240,
                          "voiceInternationalSeconds": 125,
                          "voiceLocalSeconds": 6
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "usageRecord",
                          "data": 18883100,
                          "end": "2021-02-15T00:00:00Z",
                          "labels": {},
                          "sms": 15,
                          "start": "2021-02-14T00:00:00Z",
                          "voice": 240
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/usageBalances": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Usage Balances"
        ],
        "operationId": "UsageBalancesList",
        "summary": "List all usage balances",
        "description": "Returns a list of usage balances for the given project. The list can be filtered by subscription, subscription period, or subscription add-on. When filtering by subscription without specifying subscriptionPeriod or subscriptionAddon, all usage balances for the subscription are returned regardless of source type or period.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "parameters": [
          {
            "name": "subscription",
            "in": "query",
            "description": "Filter usage balances by [Subscription](https://developers.gigs.com/core/subscriptions#the-subscription-resource) ID.",
            "schema": {
              "type": "string",
              "examples": [
                "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
              ]
            }
          },
          {
            "name": "subscriptionPeriod",
            "in": "query",
            "description": "Filter usage balances by subscription period. Requires the `subscription` parameter. Accepts a positive integer, the special value `current`, or a negative integer to request previous periods (e.g., `-1` for the previous period). Cannot be combined with `subscriptionAddon`. A usage balance is sourced from either a subscription period or a subscription add-on, never both - combining these will return an error.",
            "schema": {
              "type": "string",
              "examples": [
                "current"
              ]
            }
          },
          {
            "name": "subscriptionAddon",
            "in": "query",
            "description": "Filter usage balances by [Subscription Add-on](https://developers.gigs.com/core/subscription-add-ons#the-subscription-add-on-resource) ID. Can be combined with `subscription` but not with `subscriptionPeriod`. A usage balance is sourced from either a subscription period or a subscription add-on, never both — combining these will return an error.",
            "schema": {
              "type": "string",
              "examples": [
                "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a list of usage balances.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `usageBalance`.",
                      "items": {
                        "$ref": "#/components/schemas/usageBalance"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "usageBalance",
                          "id": "ubl_0V9n0zo90CE0NuvcsN0j88",
                          "allowance": {
                            "object": "allowance",
                            "id": "alw_0SNlurA049MEWV3OMTRrGKbd99GH",
                            "name": "Roaming data in Europe",
                            "type": "data",
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "limit": 500,
                            "unit": "bytes"
                          },
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "source": {
                            "type": "subscriptionPeriod",
                            "subscriptionPeriod": 4,
                            "subscriptionAddon": null
                          },
                          "unit": "bytes",
                          "used": 230,
                          "limit": 500,
                          "remaining": 270,
                          "usedPercent": 46,
                          "remainingPercent": 54,
                          "usableFrom": "2026-01-03T13:41:24Z",
                          "usableUntil": "2026-02-03T13:41:24Z",
                          "updatedAt": "2026-01-15T08:12:51Z"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "usageBalance",
                          "id": "ubl_0V9n0zo90CE0NuvcsN0j88",
                          "allowance": {
                            "object": "allowance",
                            "id": "alw_0SNlurA049MEWV3OMTRrGKbd99GH",
                            "name": "Roaming data in Europe",
                            "type": "data",
                            "coverage": {
                              "object": "coverage",
                              "id": "de",
                              "countries": [
                                "DE",
                                "FR",
                                "US"
                              ],
                              "name": "Europe"
                            },
                            "limit": 500,
                            "unit": "bytes"
                          },
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "source": {
                            "type": "subscriptionPeriod",
                            "subscriptionPeriod": 4,
                            "subscriptionAddon": null
                          },
                          "unit": "bytes",
                          "used": 230,
                          "limit": 500,
                          "remaining": 270,
                          "usedPercent": 46,
                          "remainingPercent": 54,
                          "usableFrom": "2026-01-03T13:41:24Z",
                          "usableUntil": "2026-02-03T13:41:24Z",
                          "updatedAt": "2026-01-15T08:12:51Z"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/usageBalances/{usageBalance}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "usageBalance",
          "in": "path",
          "description": "The unique identifier for the usage balance.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "ubl_0V9n0zo90CE0NuvcsN0j88"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Usage Balances"
        ],
        "operationId": "UsageBalancesRetrieve",
        "summary": "Retrieve a usage balance",
        "description": "Returns the details of an existing usage balance.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "responses": {
          "200": {
            "description": "Returns the usage balance.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/usageBalance"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "usageBalance",
                      "id": "ubl_0V9n0zo90CE0NuvcsN0j88",
                      "allowance": {
                        "object": "allowance",
                        "id": "alw_0SNlurA049MEWV3OMTRrGKbd99GH",
                        "name": "Roaming data in Europe",
                        "type": "data",
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "limit": 500,
                        "unit": "bytes"
                      },
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "source": {
                        "type": "subscriptionPeriod",
                        "subscriptionPeriod": 4,
                        "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                      },
                      "unit": "bytes",
                      "used": 230,
                      "limit": 500,
                      "remaining": 270,
                      "usedPercent": 46,
                      "remainingPercent": 54,
                      "usableFrom": "2026-01-03T13:41:24Z",
                      "usableUntil": "2026-02-03T13:41:24Z",
                      "updatedAt": "2026-01-15T08:12:51Z"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "usageBalance",
                      "id": "ubl_0V9n0zo90CE0NuvcsN0j88",
                      "allowance": {
                        "object": "allowance",
                        "id": "alw_0SNlurA049MEWV3OMTRrGKbd99GH",
                        "name": "Roaming data in Europe",
                        "type": "data",
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "limit": 500,
                        "unit": "bytes"
                      },
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "source": {
                        "type": "subscriptionPeriod"
                      },
                      "unit": "bytes",
                      "used": 230,
                      "limit": 500,
                      "remaining": 270,
                      "usedPercent": 46,
                      "remainingPercent": 54,
                      "usableFrom": "2026-01-03T13:41:24Z",
                      "usableUntil": "2026-02-03T13:41:24Z",
                      "updatedAt": "2026-01-15T08:12:51Z"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/testing/projects/{project}/portOuts/{portOut}/simulate": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "portOut",
          "in": "path",
          "description": "The unique identifier for the port out.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "PortOutsSimulate",
        "summary": "Simulate port out completion by network provider",
        "description": "Simulates completion of a port out for a subscription with a test SIM. Can be used to test complete flow of a successful port out with end of subscription.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "responses": {
          "200": {
            "description": "Port out completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/portOut"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/testing/projects/{project}/subscriptions/{subscription}/usage": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "subscription",
          "in": "path",
          "description": "The unique identifier for the subscription.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Usage"
        ],
        "operationId": "SubscriptionUsageSimulate",
        "summary": "Simulate subscription usage",
        "description": "Simulates usage on a subscription with a test SIM. Can be used to test usage notifications. Subscription must be in status \"active\".\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "description": "Usage parameters to simulate.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of data used in bytes.",
                    "minimum": 0,
                    "examples": [
                      18883100
                    ]
                  },
                  "dataDevice": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of on-device data used in bytes.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "minimum": 0,
                    "examples": [
                      102938120
                    ]
                  },
                  "dataTethering": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of tethering data used in bytes.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "minimum": 0,
                    "examples": [
                      102938120
                    ]
                  },
                  "voice": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of voice usage in seconds.",
                    "minimum": 0,
                    "examples": [
                      240
                    ]
                  },
                  "voiceLocal": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of local voice usage in seconds.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "minimum": 0,
                    "examples": [
                      329
                    ]
                  },
                  "voiceInternational": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of international long distance voice usage in seconds.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "minimum": 0,
                    "examples": [
                      329
                    ]
                  },
                  "sms": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of SMS messages sent and received.",
                    "minimum": 0,
                    "examples": [
                      15
                    ]
                  },
                  "smsLocal": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of local SMS messages sent and received.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "minimum": 0,
                    "examples": [
                      4
                    ]
                  },
                  "smsInternational": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "default": 0,
                    "description": "Amount of international long distance SMS messages sent and received.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "minimum": 0,
                    "examples": [
                      4
                    ]
                  },
                  "subscriptionAddon": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the subscription addon to which the simulated usage should be attributed. If not provided, the usage won't be attributed to any add-on.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                    ]
                  },
                  "country": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "ISO 3166-1 alpha-2",
                    "description": "The ISO 3166-1 alpha-2 country code to assign to the simulated usage. If not provided, the usage will be assigned to the home country of the provider.",
                    "examples": [
                      "US"
                    ]
                  },
                  "roaming": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "none",
                      "international",
                      "domestic"
                    ],
                    "default": "none",
                    "description": "The roaming mode to assign to the simulated usage.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
                  },
                  "usageBalance": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The Usage Balance id to assign the simulated usage to.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                    "examples": [
                      "ubl_0SNlurA049MEWV4VxLfwJc3PJtHc"
                    ]
                  },
                  "usageBalanceAmount": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "description": "The amount of usage to attribute to the specified Usage Balance.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "data": 18883100,
                    "dataDevice": 102938120,
                    "dataTethering": 102938120,
                    "voice": 240,
                    "voiceLocal": 329,
                    "voiceInternational": 329,
                    "sms": 15,
                    "smsLocal": 4,
                    "smsInternational": 4,
                    "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                    "country": "US",
                    "roaming": "none",
                    "usageBalance": "ubl_0SNlurA049MEWV4VxLfwJc3PJtHc"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the relevant usage record.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/usageRecord"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "usageRecord",
                      "data": 18883100,
                      "dataDeviceBytes": 30029300,
                      "dataTetheringBytes": 30029300,
                      "end": "2021-02-15T00:00:00Z",
                      "labels": {
                        "country": "US",
                        "roaming": "none",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                      },
                      "sms": 15,
                      "smsInternationalMessages": 6,
                      "smsLocalMessages": 6,
                      "start": "2021-02-14T00:00:00Z",
                      "updatedAt": "2024-02-15T12:13:14Z",
                      "voice": 240,
                      "voiceInternationalSeconds": 125,
                      "voiceLocalSeconds": 6
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "usageRecord",
                      "data": 18883100,
                      "end": "2021-02-15T00:00:00Z",
                      "labels": {},
                      "sms": 15,
                      "start": "2021-02-14T00:00:00Z",
                      "voice": 240
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/users/{user}/addresses/{address}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "$ref": "#/components/parameters/user"
        },
        {
          "name": "address",
          "in": "path",
          "description": "The unique identifier for the address.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "User Addresses"
        ],
        "operationId": "UserAddressesRetrieve",
        "summary": "Retrieve a user address",
        "description": "Retrieves the details of an existing address for a given user.",
        "responses": {
          "200": {
            "description": "Returns the address if it exists and is owned by the user.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/userAddress"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "userAddress",
                      "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "city": "New York City",
                      "country": "US",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "delete": {
        "tags": [
          "User Addresses"
        ],
        "operationId": "UserAddressesDelete",
        "summary": "Delete a user address",
        "description": "Retrieves the details of an existing user address and deletes it.",
        "responses": {
          "200": {
            "description": "Returns the address after a successful deletion.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/userAddress"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "userAddress",
                      "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "city": "New York City",
                      "country": "US",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/users/{user}/addresses": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "$ref": "#/components/parameters/user"
        }
      ],
      "get": {
        "tags": [
          "User Addresses"
        ],
        "operationId": "UserAddressesList",
        "summary": "List all user addresses",
        "description": "Returns a list of addresses owned by the given user. The addresses returned are sorted by creation date, with the most recently created addresses appearing first.",
        "responses": {
          "200": {
            "description": "Returns a list of address objects.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `userAddress`.",
                      "items": {
                        "$ref": "#/components/schemas/userAddress"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "userAddress",
                          "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                          "city": "New York City",
                          "country": "US",
                          "createdAt": "2021-01-21T19:38:34Z",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "userAddress",
                          "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                          "city": "New York City",
                          "country": "US",
                          "createdAt": "2021-01-21T19:38:34Z",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY",
                          "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "post": {
        "tags": [
          "User Addresses"
        ],
        "operationId": "UserAddressesCreate",
        "summary": "Create a user address",
        "description": "Create a new address for the given user with the provided parameters.\n\nIf any validations fail during the user address creation process,\ndetailed information will be provided in the error response body.\nIf applicable, suggested alternative values for properties that do not\npass the validations will also be included.\n\nPlease note that there is a maximum limit of 10 active addresses permitted per user.\nAttempts to exceed this limit will result in an error response. Addresses must also\nbe unique for a given user.\n",
        "requestBody": {
          "description": "User address attributes to create.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "city": {
                    "type": "string",
                    "description": "The city/municipality of the address.",
                    "maxLength": 50,
                    "examples": [
                      "New York City"
                    ]
                  },
                  "country": {
                    "type": "string",
                    "format": "ISO 3166-1 alpha-2",
                    "description": "The ISO 3166-1 alpha-2 country code of the address.",
                    "examples": [
                      "US"
                    ]
                  },
                  "line1": {
                    "type": "string",
                    "description": "The first line of the address, e.g. street and house number.",
                    "maxLength": 50,
                    "examples": [
                      "129 West 81st Street"
                    ]
                  },
                  "line2": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The second line of the address, e.g. apartment number.",
                    "maxLength": 50,
                    "examples": [
                      "Apartment 5"
                    ]
                  },
                  "state": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The state/province/region of the address. Required for US/CA addresses to be a valid ISO 3166-2 2 letter code.",
                    "maxLength": 50,
                    "examples": [
                      "NY"
                    ]
                  },
                  "postalCode": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The postal code of the address. Required for countries with postal codes.",
                    "maxLength": 15,
                    "examples": [
                      "10024"
                    ]
                  }
                },
                "required": [
                  "city",
                  "country",
                  "line1"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "city": "New York City",
                    "country": "US",
                    "line1": "129 West 81st Street",
                    "line2": "Apartment 5",
                    "state": "NY",
                    "postalCode": "10024"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "city": "New York City",
                    "country": "US",
                    "line1": "129 West 81st Street"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the created address.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/userAddress"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "userAddress",
                      "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "city": "New York City",
                      "country": "US",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "description": "The address creation request can't be processed, due to an invalid parameter or incompatible system state.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/error"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "code": {
                          "type": "string",
                          "examples": [
                            "userAddressInvalid"
                          ]
                        },
                        "details": {
                          "type": "array",
                          "description": "Optional array containing specific information for the current error. Suggestions are only available for US addresses for now.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                          "items": {
                            "allOf": [
                              {
                                "$ref": "#/components/schemas/propertyErrorDetailError"
                              },
                              {
                                "type": "object",
                                "properties": {
                                  "code": {
                                    "type": "string",
                                    "enum": [
                                      "addressPropertyInvalid",
                                      "addressPropertyIncomplete"
                                    ],
                                    "examples": [
                                      "addressPropertyInvalid"
                                    ]
                                  },
                                  "message": {
                                    "type": "string",
                                    "enum": [
                                      "Invalid value for property.",
                                      "The value for this property is incomplete or missing."
                                    ],
                                    "examples": [
                                      "Invalid value for property."
                                    ]
                                  },
                                  "property": {
                                    "type": "string",
                                    "enum": [
                                      "city",
                                      "country",
                                      "line1",
                                      "line2",
                                      "state",
                                      "postalCode"
                                    ],
                                    "examples": [
                                      "city"
                                    ]
                                  },
                                  "suggestion": {
                                    "type": [
                                      "string",
                                      "null"
                                    ],
                                    "description": "Suggested alternative to correct the corresponding property.\n\nFor example, if the value on the city field has a typo, such as\n`San Francis`, the suggestion value would read `San Francisco`.\nIf there is no available suggestion, the value will be `null`.\n"
                                  }
                                }
                              }
                            ],
                            "type": "object"
                          }
                        },
                        "message": {
                          "type": "string",
                          "examples": [
                            "The given address is not valid."
                          ]
                        }
                      }
                    }
                  ],
                  "type": "object"
                },
                "examples": {
                  "Invalid address response with suggestions and a missing field": {
                    "summary": "Invalid address response with suggestions and a missing field",
                    "value": {
                      "object": "error",
                      "code": "userAddressInvalid",
                      "details": [
                        {
                          "object": "propertyErrorDetail",
                          "code": "addressPropertyInvalid",
                          "message": "Invalid value for property.",
                          "property": "city",
                          "suggestion": "New York City"
                        },
                        {
                          "object": "propertyErrorDetail",
                          "code": "addressPropertyInvalid",
                          "message": "Invalid value for property.",
                          "property": "line1",
                          "suggestion": "129 West 81st Street"
                        },
                        {
                          "object": "propertyErrorDetail",
                          "code": "addressPropertyInvalid",
                          "message": "Invalid value for property.",
                          "property": "postalCode",
                          "suggestion": "10024"
                        },
                        {
                          "object": "propertyErrorDetail",
                          "code": "addressPropertyInvalid",
                          "message": "Invalid value for property.",
                          "property": "state",
                          "suggestion": "NY"
                        }
                      ],
                      "message": "The given address is not valid.",
                      "type": "invalid"
                    }
                  },
                  "Invalid address response with no correction suggestions": {
                    "summary": "Invalid address response with no correction suggestions",
                    "value": {
                      "object": "error",
                      "code": "userAddressInvalid",
                      "message": "The given address is not valid.",
                      "type": "invalid"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/projects/{project}/users": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "UsersList",
        "summary": "List all users",
        "description": "Returns a list of users. The users returned are sorted by creation date, with the most recently created users appearing first.",
        "parameters": [
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of user objects.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `user`.",
                      "items": {
                        "$ref": "#/components/schemas/user"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "user",
                          "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                          "metadata": {},
                          "birthday": "2017-07-21",
                          "createdAt": "2021-01-21T19:38:34Z",
                          "email": "jerry@example.com",
                          "emailVerified": true,
                          "fullName": "Jerry Seinfeld",
                          "preferredLocale": "en-US",
                          "status": "active"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "user",
                          "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                          "metadata": {},
                          "birthday": "2017-07-21",
                          "createdAt": "2021-01-21T19:38:34Z",
                          "email": "jerry@example.com",
                          "emailVerified": true,
                          "fullName": "Jerry Seinfeld",
                          "preferredLocale": "en-US",
                          "status": "active"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "UsersCreate",
        "summary": "Create a user",
        "description": "Creates a new user with the given parameters.",
        "requestBody": {
          "description": "User attributes to create.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "birthday": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date",
                    "description": "The birthday of the user.",
                    "examples": [
                      "2017-07-21"
                    ]
                  },
                  "email": {
                    "type": "string",
                    "format": "email",
                    "description": "The primary verified email address of the user.",
                    "examples": [
                      "jerry@example.com"
                    ]
                  },
                  "fullName": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The user's full name. Some plans require the user name to be present when creating a subscription. Check the plan requirements for that.",
                    "examples": [
                      "Jerry Seinfeld"
                    ]
                  },
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  },
                  "preferredLocale": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The user's locale preference represented as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). It defaults to the project's preferred locale.",
                    "examples": [
                      "en-US"
                    ]
                  }
                },
                "required": [
                  "email"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "birthday": "2017-07-21",
                    "email": "jerry@example.com",
                    "fullName": "Jerry Seinfeld",
                    "metadata": {},
                    "preferredLocale": "en-US"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "email": "jerry@example.com"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the created user.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/user"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/users/{user}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "user",
          "in": "path",
          "description": "The unique identifier for the user.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Users"
        ],
        "operationId": "UsersRetrieve",
        "summary": "Retrieve a user",
        "description": "Retrieves the details of an existing user. You need only supply the unique user identifier that was returned upon user creation.",
        "responses": {
          "200": {
            "description": "Returns the user object if the user exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/user"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "delete": {
        "tags": [
          "Users"
        ],
        "operationId": "UsersDelete",
        "summary": "Delete a user",
        "description": "Retrieves the details of an existing user and deletes it.",
        "responses": {
          "200": {
            "description": "Returns the user after a successful deletion.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/user"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "patch": {
        "tags": [
          "Users"
        ],
        "operationId": "UsersUpdate",
        "summary": "Update a user",
        "description": "Updates the specified user by setting the values of the parameters passed.",
        "requestBody": {
          "description": "User attributes to update.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "birthday": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date",
                    "description": "The birthday of the user.",
                    "examples": [
                      "2017-07-21"
                    ]
                  },
                  "email": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "email",
                    "description": "The primary verified email address of the user.",
                    "examples": [
                      "jerry@example.com"
                    ]
                  },
                  "fullName": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The user's full name. Required for some Plans.",
                    "examples": [
                      "Jerry Seinfeld"
                    ]
                  },
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  },
                  "preferredLocale": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The user's locale preference represented as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag).",
                    "examples": [
                      "en-US"
                    ]
                  }
                },
                "required": []
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "birthday": "2017-07-21",
                    "email": "jerry@example.com",
                    "fullName": "Jerry Seinfeld",
                    "metadata": {},
                    "preferredLocale": "en-US"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the updated user.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/user"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/users/search": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "UsersSearch",
        "summary": "Search for users",
        "description": "Searches for existing users matching the given parameters.",
        "requestBody": {
          "description": "User attributes to search by.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "email",
                    "description": "The primary email address of the user.",
                    "examples": [
                      "jerry@example.com"
                    ]
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "email": "jerry@example.com"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the users matching the search criteria.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `user`.",
                      "items": {
                        "$ref": "#/components/schemas/user"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "user",
                          "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                          "metadata": {},
                          "birthday": "2017-07-21",
                          "createdAt": "2021-01-21T19:38:34Z",
                          "email": "jerry@example.com",
                          "emailVerified": true,
                          "fullName": "Jerry Seinfeld",
                          "preferredLocale": "en-US",
                          "status": "active"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "user",
                          "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                          "metadata": {},
                          "birthday": "2017-07-21",
                          "createdAt": "2021-01-21T19:38:34Z",
                          "email": "jerry@example.com",
                          "emailVerified": true,
                          "fullName": "Jerry Seinfeld",
                          "preferredLocale": "en-US",
                          "status": "active"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/creditNotes": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Credit Notes"
        ],
        "operationId": "CreditNotesList",
        "summary": "List all credit notes",
        "description": "Returns a list of credit notes.",
        "parameters": [
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          },
          {
            "name": "invoice",
            "in": "query",
            "description": "The unique identifier for the invoice to be filtered by.",
            "schema": {
              "type": "string",
              "examples": [
                "inv_0SNlurA049MEWV1QTRqvd18YuG25"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "A comma-separated list of statuses to filter the credit notes by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "issued",
                  "voided"
                ]
              }
            },
            "style": "form",
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of credit notes.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `creditNote`.",
                      "items": {
                        "$ref": "#/components/schemas/creditNote"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "creditNote",
                          "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                          "metadata": {},
                          "createdAt": "2024-06-14T19:38:34Z",
                          "creditTo": "outOfBand",
                          "fees": [
                            {
                              "amount": {
                                "amount": 100,
                                "currency": "USD"
                              },
                              "name": "Recovery Fee",
                              "type": "recoveryFee"
                            }
                          ],
                          "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                          "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                          "lineItems": [
                            {
                              "amount": {
                                "amount": 999,
                                "currency": "USD"
                              },
                              "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                              "tax": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "taxes": [
                                {
                                  "amount": {
                                    "amount": 200,
                                    "currency": "USD"
                                  },
                                  "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                                }
                              ],
                              "total": {
                                "amount": 1199,
                                "currency": "USD"
                              }
                            }
                          ],
                          "number": "3l4rLP-DE-CN-2026-06-10001",
                          "status": "issued",
                          "subtotal": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          },
                          "voidedAt": "2024-06-14T19:38:34Z"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "creditNote",
                          "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                          "metadata": {},
                          "createdAt": "2024-06-14T19:38:34Z",
                          "creditTo": "outOfBand",
                          "fees": [
                            {
                              "amount": {
                                "amount": 100,
                                "currency": "USD"
                              },
                              "name": "Recovery Fee",
                              "type": "recoveryFee"
                            }
                          ],
                          "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                          "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                          "lineItems": [
                            {
                              "amount": {
                                "amount": 999,
                                "currency": "USD"
                              },
                              "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                              "tax": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "taxes": [
                                {
                                  "amount": {
                                    "amount": 200,
                                    "currency": "USD"
                                  },
                                  "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                                }
                              ],
                              "total": {
                                "amount": 1199,
                                "currency": "USD"
                              }
                            }
                          ],
                          "number": "3l4rLP-DE-CN-2026-06-10001",
                          "status": "issued",
                          "subtotal": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          },
                          "voidedAt": "2024-06-14T19:38:34Z"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "post": {
        "tags": [
          "Credit Notes"
        ],
        "operationId": "CreditNotesCreate",
        "summary": "Create a credit note",
        "description": "Creates a new credit note for an invoice.\n\nWhen only `invoice` is provided, the full amount of the invoice will be credited, including all taxes and fees.\nIf the invoice has already been partially credited, the remaining amount will be credited.\n\nWhen selected `lineItems`, `taxes` or `fees` are provided, only those will be credited. \n\nNon-refundable taxes will still have to be filed with the tax authorities.\n",
        "requestBody": {
          "description": "Properties of the new credit note.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "invoice": {
                    "type": "string",
                    "description": "The unique identifier for the invoice that the credit note applies to.",
                    "examples": [
                      "inv_0SNlurA049MEWV1QTRqvd18YuG25"
                    ]
                  },
                  "metadata": {
                    "$ref": "#/components/schemas/metadataUpdate"
                  },
                  "lineItems": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "description": "The line items for the credit note.",
                    "items": {
                      "type": "object",
                      "properties": {
                        "invoiceLineItem": {
                          "type": "string",
                          "description": "The unique identifier for the invoice line item that this line item applies to.",
                          "examples": [
                            "lin_0SNlurA049MEWV11QUKZGDMxJmKe"
                          ]
                        },
                        "amount": {
                          "type": [
                            "integer",
                            "null"
                          ],
                          "description": "The amount to be credited for the line item in the currency of the invoice. If not provided or null the line item will not be credited, but taxes will be credited if provided.",
                          "minimum": 0,
                          "examples": [
                            999
                          ]
                        },
                        "taxes": {
                          "type": "array",
                          "description": "The taxes to be credited for this line item. If not provided, no taxes for this line item will be credited.",
                          "items": {
                            "type": "object",
                            "properties": {
                              "invoiceTax": {
                                "type": "string",
                                "description": "The unique identifier for the invoice tax that this tax applies to.",
                                "examples": [
                                  "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                                ]
                              },
                              "amount": {
                                "type": "integer",
                                "description": "The amount to be credited for the tax in the currency of the invoice.",
                                "minimum": 0,
                                "examples": [
                                  200
                                ]
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "fees": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "description": "The fees to be credited.",
                    "items": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "description": "The type of fee to be credited."
                        },
                        "amount": {
                          "type": "integer",
                          "description": "The amount to be credited for the fee in the currency of the invoice.",
                          "minimum": 0,
                          "examples": [
                            999
                          ]
                        }
                      }
                    }
                  }
                },
                "required": [
                  "invoice"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                    "metadata": {},
                    "lineItems": [
                      {
                        "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                        "amount": 999,
                        "taxes": [
                          {
                            "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3",
                            "amount": 200
                          }
                        ]
                      }
                    ],
                    "fees": [
                      {
                        "amount": 999
                      }
                    ]
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the created credit note.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/creditNote"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/creditNotes/{creditNote}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "creditNote",
          "in": "path",
          "description": "The unique identifier for the credit note.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "crn_0SNlurA049MEWV49X25tqzNV2jji"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Credit Notes"
        ],
        "operationId": "CreditNotesRetrieve",
        "summary": "Retrieve a credit note",
        "description": "Retrieves the details of an existing credit note.",
        "responses": {
          "200": {
            "description": "Returns the credit note.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/creditNote"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/creditNotes/{creditNote}/void": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "creditNote",
          "in": "path",
          "description": "The unique identifier for the credit note.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "crn_0SNlurA049MEWV49X25tqzNV2jji"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Credit Notes"
        ],
        "operationId": "CreditNotesVoid",
        "summary": "Void a credit note",
        "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This endpoint is deprecated and will be removed in the future.\n> This endpoint should no longer be used and will be removed in a future version.\n\n\nMarks the credit note as void. This reverses the credited amount in the invoice and reported taxes.",
        "responses": {
          "200": {
            "description": "Returns the voided credit note.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/creditNote"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        },
        "deprecated": true
      }
    },
    "/projects/{project}/invoices": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Invoices"
        ],
        "operationId": "InvoicesList",
        "summary": "List all invoices",
        "description": "Returns a list of invoices.",
        "parameters": [
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          },
          {
            "name": "user",
            "in": "query",
            "description": "The unique identifier of the user to filter by.",
            "schema": {
              "type": "string",
              "examples": [
                "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
              ]
            }
          },
          {
            "name": "subscription",
            "in": "query",
            "description": "The unique identifier of the subscription to filter by.",
            "schema": {
              "type": "string",
              "examples": [
                "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
              ]
            }
          },
          {
            "name": "subscriptionAddon",
            "in": "query",
            "description": "The unique identifier of the subscription addon to filter by.",
            "schema": {
              "type": "string",
              "examples": [
                "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
              ]
            }
          },
          {
            "name": "subscriptionChange",
            "in": "query",
            "description": "The unique identifier of the subscription change to filter by.",
            "schema": {
              "type": "string",
              "examples": [
                "sch_0SNlurA049MEWV3bE0SMtbIEJApp"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "A comma-separated list of statuses to filter by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "draft",
                  "finalized",
                  "paid",
                  "voided"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "reason",
            "in": "query",
            "description": "A comma-separated list of reasons to filter by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "other",
                  "subscriptionChange",
                  "subscriptionCreation",
                  "subscriptionRenewal",
                  "subscriptionRestore"
                ]
              }
            },
            "style": "form",
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of invoices.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `invoice`.",
                      "items": {
                        "$ref": "#/components/schemas/invoice"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "invoice",
                          "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                          "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                          "appliedBalance": {
                            "amount": 1199,
                            "currency": "USD"
                          },
                          "createdAt": "2024-01-09T15:00:51Z",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "dueAt": "2024-02-01T11:12:13Z",
                          "expiresAt": "2024-02-11T11:13:13Z",
                          "fees": [
                            {
                              "amount": {
                                "amount": 100,
                                "currency": "USD"
                              },
                              "name": "Recovery Fee",
                              "type": "recoveryFee"
                            }
                          ],
                          "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                          "finalizedAt": "2024-02-01T11:12:13Z",
                          "lineItems": [
                            {
                              "object": "invoiceLineItem",
                              "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                              "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                              "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                              "discount": {
                                "amount": 100,
                                "currency": "USD"
                              },
                              "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                              "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                              "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                              "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                              "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"
                              }
                            }
                          ],
                          "number": "3l4rLP-DE-2026-06-10001",
                          "overdueAt": "2024-02-01T11:13:13Z",
                          "paidAt": "2024-02-01T11:13:13Z",
                          "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": 200,
                            "currency": "USD"
                          },
                          "taxExemptionReason": "calculationFailed",
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          },
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "invoice",
                          "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                          "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                          "appliedBalance": {
                            "amount": 1199,
                            "currency": "USD"
                          },
                          "createdAt": "2024-01-09T15:00:51Z",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "dueAt": "2024-02-01T11:12:13Z",
                          "expiresAt": "2024-02-11T11:13:13Z",
                          "fees": [
                            {
                              "amount": {
                                "amount": 100,
                                "currency": "USD"
                              },
                              "name": "Recovery Fee",
                              "type": "recoveryFee"
                            }
                          ],
                          "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                          "finalizedAt": "2024-02-01T11:12:13Z",
                          "lineItems": [
                            {
                              "object": "invoiceLineItem",
                              "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                              "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                              "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                              "discount": {
                                "amount": 100,
                                "currency": "USD"
                              },
                              "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                              "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                              "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                              "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                              "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"
                              }
                            }
                          ],
                          "number": "3l4rLP-DE-2026-06-10001",
                          "overdueAt": "2024-02-01T11:13:13Z",
                          "paidAt": "2024-02-01T11:13:13Z",
                          "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": 200,
                            "currency": "USD"
                          },
                          "taxExemptionReason": "calculationFailed",
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          },
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/invoices/{invoice}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "invoice",
          "in": "path",
          "description": "The unique identifier for the invoice.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "inv_0SNlurA049MEWV1QTRqvd18YuG25"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Invoices"
        ],
        "operationId": "InvoicesRetrieve",
        "summary": "Retrieve an invoice",
        "description": "Retrieves the details of an existing invoice.",
        "responses": {
          "200": {
            "description": "Returns the invoice.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/invoices/{invoice}/pay": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "invoice",
          "in": "path",
          "description": "The unique identifier for the invoice.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "inv_0SNlurA049MEWV1QTRqvd18YuG25"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Invoices"
        ],
        "operationId": "InvoicesPay",
        "summary": "Pay an invoice",
        "description": "Marks the invoice as paid. This activates or allows to renew the products associated with the invoice.",
        "responses": {
          "200": {
            "description": "Returns the invoice.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/quotes": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "Quotes"
        ],
        "operationId": "QuotesCreate",
        "summary": "Create a quote",
        "description": "Creates a quote for the given plan or add-on, allowing you to preview its final price with all applicable taxes and fees.",
        "requestBody": {
          "description": "Properties of the new quote.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "addon": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the addon for which this quote is being created. Either plan or addon should be present, but not both.",
                    "examples": [
                      "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
                    ]
                  },
                  "address": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier representing the address for tax calculation purposes. Required when quoting local plans or addons for local plans.",
                    "examples": [
                      "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
                    ]
                  },
                  "creditedPlan": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the credited plan this quote is being created with. The price of the credited plan is used to adjust the final plan price when quoting immediate subscription changes.",
                    "examples": [
                      "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                    ]
                  },
                  "plan": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the plan for which this quote is being created. Either plan or addon should be present, but not both.",
                    "examples": [
                      "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                    ]
                  },
                  "user": {
                    "type": "string",
                    "description": "The unique identifier for the user for which this quote is being created.",
                    "examples": [
                      "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    ]
                  },
                  "voucher": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the voucher to apply to this quote.",
                    "examples": [
                      "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    ]
                  }
                },
                "required": [
                  "user"
                ]
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                    "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                    "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                    "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                    "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the created quote.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/quote"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "quote",
                      "id": "quo_0SNlurA049MEWV2X9NicYieFQ4Kc",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "expiredAt": "2024-02-01T11:12:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "lineItems": [
                        {
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subtotal": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "inclusive": false,
                              "jurisdiction": "Federal",
                              "name": "Federal TRS Fund"
                            }
                          ],
                          "total": {
                            "amount": 1099,
                            "currency": "USD"
                          }
                        }
                      ],
                      "reason": "other",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/quotes/{quote}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "quote",
          "in": "path",
          "description": "The unique identifier for the quote.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "quo_0SNlurA049MEWV2X9NicYieFQ4Kc"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Quotes"
        ],
        "operationId": "QuotesRetrieve",
        "summary": "Retrieve a quote",
        "description": "Retrieves the details of an existing quote.",
        "responses": {
          "200": {
            "description": "Returns the quote.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/quote"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "quote",
                      "id": "quo_0SNlurA049MEWV2X9NicYieFQ4Kc",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "expiredAt": "2024-02-01T11:12:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "lineItems": [
                        {
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subtotal": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "inclusive": false,
                              "jurisdiction": "Federal",
                              "name": "Federal TRS Fund"
                            }
                          ],
                          "total": {
                            "amount": 1099,
                            "currency": "USD"
                          }
                        }
                      ],
                      "reason": "other",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/vouchers": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "get": {
        "tags": [
          "Vouchers"
        ],
        "operationId": "VouchersList",
        "summary": "List all vouchers",
        "description": "Returns a list of vouchers. The vouchers returned are sorted by creation date, with the most recently created vouchers appearing first.",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "The status to filter the vouchers by.",
            "schema": {
              "type": "array",
              "default": [
                "available"
              ],
              "items": {
                "type": "string",
                "enum": [
                  "available",
                  "retired"
                ]
              }
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "code",
            "in": "query",
            "description": "The voucher code to filter the vouchers by. An empty code matches no vouchers.",
            "schema": {
              "type": "string",
              "examples": [
                "SummerCode"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/listAfter"
          },
          {
            "$ref": "#/components/parameters/listBefore"
          },
          {
            "$ref": "#/components/parameters/listLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a dictionary with an items property that contains an array of vouchers.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "const": "list",
                      "description": "Type of object is always `list`."
                    },
                    "items": {
                      "type": "array",
                      "description": "List of objects of type `voucher`.",
                      "items": {
                        "$ref": "#/components/schemas/voucher"
                      }
                    },
                    "moreItemsAfter": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `after` pagination parameter if more items are available sorted after the current batch of items."
                    },
                    "moreItemsBefore": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "A unique identifier to be used as `before` pagination parameter if more items are available sorted before the current batch of items."
                    }
                  },
                  "required": [
                    "object",
                    "items",
                    "moreItemsAfter",
                    "moreItemsBefore"
                  ]
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "voucher",
                          "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "createdAt": "2021-02-14T19:38:34Z",
                          "name": "Black Friday",
                          "priceDiscount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "priceDiscountPercentage": 30.12,
                          "recurrence": {
                            "type": "once",
                            "durationInMonths": null
                          },
                          "redemptions": 2,
                          "retiredReason": null,
                          "status": "available"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "list",
                      "items": [
                        {
                          "object": "voucher",
                          "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "createdAt": "2021-02-14T19:38:34Z",
                          "name": "Black Friday",
                          "priceDiscount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "priceDiscountPercentage": 30.12,
                          "recurrence": {
                            "type": "once",
                            "durationInMonths": null
                          },
                          "redemptions": 2,
                          "retiredReason": null,
                          "status": "available"
                        }
                      ],
                      "moreItemsAfter": null,
                      "moreItemsBefore": null
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      },
      "post": {
        "tags": [
          "Vouchers"
        ],
        "operationId": "VouchersCreate",
        "summary": "Create a voucher",
        "description": "Creates a new voucher in the specified project.",
        "requestBody": {
          "description": "Optional and required parameters to be passed in the request body to create a voucher.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "The voucher's name.",
                    "examples": [
                      "Monthly Basic 15%"
                    ]
                  },
                  "priceDiscount": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "The price amount of the discount applied via the voucher. A voucher object has always either a priceDiscount or a priceDiscountPercentage.",
                    "properties": {
                      "amount": {
                        "type": "integer",
                        "description": "The discount amount in the currency's minor unit, e.g. \"cents\" for many currencies.\n\nMost currencies have two decimals, so USD 9.99 is `999`. These currencies have a different number of decimals, e.g. JPY 28,500 is `28500`:\n\n- 0 decimals: CLP, ISK, JPY, KRW\n",
                        "minimum": 1,
                        "examples": [
                          999
                        ]
                      },
                      "currency": {
                        "type": "string",
                        "format": "ISO 4217",
                        "description": "Three-letter ISO 4217 currency code. Must be a supported currency.",
                        "examples": [
                          "USD"
                        ]
                      }
                    },
                    "required": [
                      "amount",
                      "currency"
                    ]
                  },
                  "priceDiscountPercentage": {
                    "type": [
                      "number",
                      "null"
                    ],
                    "description": "The percentage amount of the discount applied via the voucher. A voucher object has always either a priceDiscount or a priceDiscountPercentage.",
                    "maximum": 100,
                    "minimum": 1,
                    "examples": [
                      30.12
                    ]
                  },
                  "recurrence": {
                    "type": "object",
                    "description": "Details on whether and for how long the discounts applied via the voucher recur.",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "once",
                          "repeating",
                          "forever"
                        ],
                        "description": "Whether and how the voucher discount recurs.",
                        "examples": [
                          "once"
                        ]
                      },
                      "durationInMonths": {
                        "type": [
                          "integer",
                          "null"
                        ],
                        "description": "For how many months is the discount applied via the voucher. Only applicable when 'recurrence.type' is 'repeating'. Can't be combined with 'durationInPeriods'.",
                        "minimum": 1
                      }
                    },
                    "required": [
                      "type"
                    ]
                  }
                },
                "required": [
                  "name",
                  "recurrence"
                ]
              },
              "examples": {
                "One time flat discount": {
                  "summary": "One time flat discount",
                  "value": {
                    "name": "Monthly Basic 15%",
                    "priceDiscount": {
                      "amount": 999,
                      "currency": "USD"
                    },
                    "priceDiscountPercentage": null,
                    "recurrence": {
                      "type": "once",
                      "durationInMonths": null
                    }
                  }
                },
                "Recurring percentage discount": {
                  "summary": "Recurring percentage discount",
                  "value": {
                    "name": "Monthly Basic 15%",
                    "priceDiscount": null,
                    "priceDiscountPercentage": 30.12,
                    "recurrence": {
                      "type": "repeating",
                      "durationInMonths": 3
                    }
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the newly created voucher.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/voucher"
                },
                "examples": {
                  "One time flat discount": {
                    "summary": "One time flat discount",
                    "value": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": null,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    }
                  },
                  "Recurring percentage discount": {
                    "summary": "Recurring percentage discount",
                    "value": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": null,
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "repeating",
                        "durationInMonths": 3
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/vouchers/{voucher}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "voucher",
          "in": "path",
          "description": "The unique identifier for the voucher.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
            ]
          }
        }
      ],
      "get": {
        "tags": [
          "Vouchers"
        ],
        "operationId": "VouchersRetrieve",
        "summary": "Retrieve a voucher",
        "description": "Retrieves the details of an existing voucher. You need only supply the unique voucher identifier that was returned upon voucher creation.",
        "responses": {
          "200": {
            "description": "Returns the voucher object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/voucher"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      }
    },
    "/projects/{project}/vouchers/{voucher}/retire": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "voucher",
          "in": "path",
          "description": "The unique identifier for the voucher.",
          "required": true,
          "schema": {
            "type": "string",
            "examples": [
              "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
            ]
          }
        }
      ],
      "post": {
        "tags": [
          "Vouchers"
        ],
        "operationId": "VouchersRetire",
        "summary": "Retire a voucher",
        "description": "Retires the voucher. This marks the voucher as no longer redeemable for new subscriptions, but does not affect any active discounts.",
        "responses": {
          "200": {
            "description": "Returns the voucher.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/voucher"
                },
                "examples": {
                  "Example - Full": {
                    "summary": "Example - Full",
                    "value": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    }
                  },
                  "Example - Required": {
                    "summary": "Example - Required",
                    "value": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/connectSessions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        }
      ],
      "post": {
        "tags": [
          "Connect Sessions"
        ],
        "operationId": "ConnectSessionsCreate",
        "summary": "Create a connect session",
        "description": "Creates a new Connect Session for the given parameters.\n\nRelated guide: [Connect Sessions](https://developers.gigs.com/docs/connect/connect-sessions/about)\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "description": "Optional and required parameters to be passed in the request body to create a new Connect Session.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "appearance": {
                    "type": "object",
                    "title": "Appearance",
                    "properties": {
                      "theme": {
                        "type": "string",
                        "enum": [
                          "light",
                          "dark"
                        ],
                        "description": "The theme setting that will influence the visual appearance during the Connect Session.",
                        "examples": [
                          "light"
                        ]
                      }
                    },
                    "required": []
                  },
                  "callbackUrl": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "uri",
                    "description": "The URL to which the user will be redirected after the Connect Session is completed.",
                    "examples": [
                      "https://example.com"
                    ]
                  },
                  "intent": {
                    "type": "object",
                    "title": "IntentCreate",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "browseDataPackages",
                          "cancelSubscription",
                          "changeSubscription",
                          "checkoutAddon",
                          "checkoutNewSubscription",
                          "completePorting",
                          "confirmPayment",
                          "evergreenRoaming",
                          "manageDataPackages",
                          "replaceSim",
                          "requestSupport",
                          "resumeSubscription",
                          "updatePaymentMethod",
                          "updateUserAddress",
                          "updateUserFullName",
                          "viewEsimInstallation",
                          "viewSubscription",
                          "viewSubscriptions"
                        ],
                        "description": "The type of intent."
                      },
                      "browseDataPackages": {
                        "type": "object",
                        "properties": {
                          "plan": {
                            "type": "string",
                            "description": "The unique identifier for the plan to browse data packages for.",
                            "examples": [
                              "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                            ]
                          }
                        },
                        "required": [
                          "plan"
                        ]
                      },
                      "cancelSubscription": {
                        "type": "object",
                        "properties": {
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to cancel.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        },
                        "required": [
                          "subscription"
                        ]
                      },
                      "changeSubscription": {
                        "type": "object",
                        "properties": {
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to modify.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        },
                        "required": [
                          "subscription"
                        ]
                      },
                      "checkoutAddon": {
                        "type": "object",
                        "properties": {
                          "addons": {
                            "type": "array",
                            "description": "List of unique identifiers for the add-ons to subscribe.",
                            "items": {
                              "type": "string",
                              "examples": [
                                "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
                              ]
                            }
                          },
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to modify.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        },
                        "required": [
                          "addons",
                          "subscription"
                        ]
                      },
                      "checkoutNewSubscription": {
                        "type": "object",
                        "properties": {
                          "device": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "The unique identifier for the existing device to use.",
                            "examples": [
                              "dev_0SNlurA049MEWV55CrA9qMvI2FVJ"
                            ]
                          },
                          "plan": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "The unique identifier for the plan to subscribe.",
                            "examples": [
                              "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                            ]
                          },
                          "sim": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "The unique identifier for the SIM to use.",
                            "examples": [
                              "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                            ]
                          },
                          "imei": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "pattern": "^[0-9]{15,16}$",
                            "description": "The IMEI (international mobile equipment identity) of the corresponding device.",
                            "examples": [
                              "492388841798923"
                            ]
                          },
                          "voucherCode": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "Applies a voucher code to the session. The voucher code is visible to the user in the payment step. It can be overwritten by defining a URL query parameter or by the user directly.",
                            "examples": [
                              "PROMO10"
                            ]
                          }
                        }
                      },
                      "completePorting": {
                        "type": "object",
                        "properties": {
                          "behavior": {
                            "type": "object",
                            "title": "Complete Porting: Behavior",
                            "description": "Behavior flags that customize the Complete Porting flow in Connect.",
                            "properties": {
                              "hideIntroPage": {
                                "type": "boolean",
                                "description": "When true, skips the intro screen in the Complete Porting intent and navigates users directly to the first required step.",
                                "examples": [
                                  true
                                ]
                              },
                              "hideOutroPage": {
                                "type": "boolean",
                                "description": "When true, hides the outro screen after the Complete Porting intent is fullfilled and returns users immediately to the `callbackUrl` (if provided).",
                                "examples": [
                                  true
                                ]
                              }
                            },
                            "required": []
                          },
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to complete porting.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        },
                        "required": [
                          "subscription"
                        ]
                      },
                      "confirmPayment": {
                        "type": "object",
                        "properties": {
                          "payment": {
                            "type": "string",
                            "description": "The unique identifier for the payment to be confirmed.",
                            "examples": [
                              "pay_0SNlurA049MEWV2HRA0slWFuS8DV"
                            ]
                          }
                        },
                        "required": [
                          "payment"
                        ]
                      },
                      "evergreenRoaming": {
                        "type": "object",
                        "properties": {
                          "plan": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "The unique identifier for the plan. The flow opens the user's latest subscription on this plan, or creates one. Mutually exclusive with `subscription`. Cannot be combined with `entryPoint`.",
                            "examples": [
                              "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                            ]
                          },
                          "subscription": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "The unique identifier for the subscription. Mutually exclusive with `plan`.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          },
                          "entryPoint": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "enum": [
                              "browseDataPackages",
                              "viewEsimInstallation",
                              "manageDataPackages"
                            ],
                            "description": "The entry point for the evergreen roaming flow.",
                            "examples": [
                              "browseDataPackages"
                            ]
                          }
                        }
                      },
                      "manageDataPackages": {
                        "type": "object",
                        "properties": {
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to manage data packages for.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        },
                        "required": [
                          "subscription"
                        ]
                      },
                      "replaceSim": {
                        "type": "object",
                        "properties": {
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to replace the SIM in.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        },
                        "required": [
                          "subscription"
                        ]
                      },
                      "requestSupport": {
                        "type": "object",
                        "properties": {
                          "subscription": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "The unique identifier for the subscription to request support for.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        }
                      },
                      "resumeSubscription": {
                        "type": "object",
                        "properties": {
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to resume.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        },
                        "required": [
                          "subscription"
                        ]
                      },
                      "viewEsimInstallation": {
                        "type": "object",
                        "properties": {
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to view eSIM installation.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          },
                          "entryPoint": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "enum": [
                              "another-device",
                              "manual"
                            ],
                            "description": "The entry point for the eSIM installation flow.",
                            "examples": [
                              "manual"
                            ]
                          }
                        },
                        "required": [
                          "subscription"
                        ]
                      },
                      "viewSubscription": {
                        "type": "object",
                        "properties": {
                          "subscription": {
                            "type": "string",
                            "description": "The unique identifier for the subscription to view.",
                            "examples": [
                              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                            ]
                          }
                        },
                        "required": [
                          "subscription"
                        ]
                      }
                    },
                    "required": [
                      "type"
                    ]
                  },
                  "user": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier of the user.",
                    "examples": [
                      "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    ]
                  },
                  "userDetails": {
                    "type": "object",
                    "properties": {
                      "birthday": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date",
                        "description": "The birthday of the user.",
                        "examples": [
                          "2017-07-21"
                        ]
                      },
                      "email": {
                        "type": "string",
                        "format": "email",
                        "description": "The primary verified email address of the user.",
                        "examples": [
                          "jerry@example.com"
                        ]
                      },
                      "fullName": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The user's full name. Some plans require the user name to be present when creating a subscription. Check the plan requirements for that.",
                        "examples": [
                          "Jerry Seinfeld"
                        ]
                      },
                      "metadata": {
                        "$ref": "#/components/schemas/metadataUpdate"
                      },
                      "preferredLocale": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The user's locale preference represented as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). It defaults to the project's preferred locale.",
                        "examples": [
                          "en-US"
                        ]
                      }
                    },
                    "required": [
                      "email"
                    ]
                  }
                },
                "required": [
                  "intent"
                ]
              },
              "examples": {
                "Example": {
                  "summary": "Example",
                  "value": {
                    "appearance": {
                      "theme": "light"
                    },
                    "callbackUrl": "https://example.com",
                    "intent": {
                      "type": "browseDataPackages",
                      "browseDataPackages": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      }
                    },
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                    "userDetails": {
                      "birthday": "2017-07-21",
                      "email": "jerry@example.com",
                      "fullName": "Jerry Seinfeld",
                      "metadata": {},
                      "preferredLocale": "en-US"
                    }
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Returns the newly created Connect Session.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/connectSession"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "connectSession",
                      "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
                      "appearance": {
                        "theme": "light"
                      },
                      "callbackUrl": "https://example.com",
                      "intent": {
                        "browseDataPackages": {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        },
                        "type": "browseDataPackages"
                      },
                      "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    },
    "/projects/{project}/connectSessions/{connectSessionId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/project"
        },
        {
          "name": "connectSessionId",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "tags": [
          "Connect Sessions"
        ],
        "operationId": "ConnectSessionsRetrieve",
        "summary": "Retrieve a connect session",
        "description": "Retrieves the details of an existing Connect Session.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "responses": {
          "200": {
            "description": "Returns the Connect Session if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/connectSession"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "connectSession",
                      "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
                      "appearance": {
                        "theme": "light"
                      },
                      "callbackUrl": "https://example.com",
                      "intent": {
                        "browseDataPackages": {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        },
                        "type": "browseDataPackages"
                      },
                      "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          }
        }
      },
      "patch": {
        "tags": [
          "Connect Sessions"
        ],
        "operationId": "ConnectSessionsUpdate",
        "summary": "Update a connect session",
        "description": "Updates the Connect Session with the given parameters.\n\nThe `user` or `userDetails` attributes can only be set when the session is not associated with a user yet.\n\nRelated guide: [Connect Sessions](https://developers.gigs.com/docs/connect/connect-sessions/about)\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This endpoint is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "description": "The Connect Session parameters to update.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "appearance": {
                    "type": "object",
                    "title": "Appearance",
                    "properties": {
                      "theme": {
                        "type": "string",
                        "enum": [
                          "light",
                          "dark"
                        ],
                        "description": "The theme setting that will influence the visual appearance during the Connect Session.",
                        "examples": [
                          "light"
                        ]
                      }
                    },
                    "required": []
                  },
                  "callbackUrl": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The URL to which the user will be redirected after the Connect Session is completed.",
                    "examples": [
                      "https://example.com"
                    ]
                  },
                  "user": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier of the user.",
                    "examples": [
                      "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    ]
                  },
                  "userDetails": {
                    "type": "object",
                    "properties": {
                      "birthday": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "format": "date",
                        "description": "The birthday of the user.",
                        "examples": [
                          "2017-07-21"
                        ]
                      },
                      "email": {
                        "type": "string",
                        "format": "email",
                        "description": "The primary verified email address of the user.",
                        "examples": [
                          "jerry@example.com"
                        ]
                      },
                      "fullName": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The user's full name. Some plans require the user name to be present when creating a subscription. Check the plan requirements for that.",
                        "examples": [
                          "Jerry Seinfeld"
                        ]
                      },
                      "metadata": {
                        "$ref": "#/components/schemas/metadataUpdate"
                      },
                      "preferredLocale": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The user's locale preference represented as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). It defaults to the project's preferred locale.",
                        "examples": [
                          "en-US"
                        ]
                      }
                    },
                    "required": [
                      "email"
                    ]
                  }
                }
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "appearance": {
                      "theme": "light"
                    },
                    "callbackUrl": "https://example.com",
                    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                    "userDetails": {
                      "birthday": "2017-07-21",
                      "email": "jerry@example.com",
                      "fullName": "Jerry Seinfeld",
                      "metadata": {},
                      "preferredLocale": "en-US"
                    }
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Returns the updated Connect Session.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/connectSession"
                },
                "examples": {
                  "Example": {
                    "summary": "Example",
                    "value": {
                      "object": "connectSession",
                      "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
                      "appearance": {
                        "theme": "light"
                      },
                      "callbackUrl": "https://example.com",
                      "intent": {
                        "browseDataPackages": {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        },
                        "type": "browseDataPackages"
                      },
                      "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/permissionDenied"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "422": {
            "$ref": "#/components/responses/unprocessableEntity"
          }
        }
      }
    }
  },
  "webhooks": {
    "com.gigs.apiKey.created": {
      "post": {
        "tags": [
          "API Keys"
        ],
        "operationId": "com.gigs.apiKey.created",
        "summary": "com.gigs.apiKey.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.apiKey.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "apiKey",
                      "id": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "createdAt": "2022-02-14T19:38:34Z",
                      "expiresAt": "2022-02-21T19:38:34Z",
                      "name": "My first Gigs API integration",
                      "token": "gpk_2W4IoEFH••••"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.apiKey.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "apiKey",
                      "id": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "createdAt": "2022-02-14T19:38:34Z",
                      "expiresAt": "2022-02-21T19:38:34Z",
                      "name": "My first Gigs API integration",
                      "token": "gpk_2W4IoEFH••••"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.apiKey.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.apiKey.deleted": {
      "post": {
        "tags": [
          "API Keys"
        ],
        "operationId": "com.gigs.apiKey.deleted",
        "summary": "com.gigs.apiKey.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.apiKey.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "apiKey",
                      "id": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "createdAt": "2022-02-14T19:38:34Z",
                      "expiresAt": "2022-02-21T19:38:34Z",
                      "name": "My first Gigs API integration",
                      "token": "gpk_2W4IoEFH••••"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.apiKey.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "apiKey",
                      "id": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "createdAt": "2022-02-14T19:38:34Z",
                      "expiresAt": "2022-02-21T19:38:34Z",
                      "name": "My first Gigs API integration",
                      "token": "gpk_2W4IoEFH••••"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.apiKey.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.addon.archived": {
      "post": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "com.gigs.addon.archived",
        "summary": "com.gigs.addon.archived",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.addon.archived"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.archived",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.archived",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.addon.created": {
      "post": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "com.gigs.addon.created",
        "summary": "com.gigs.addon.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.addon.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.addon.deleted": {
      "post": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "com.gigs.addon.deleted",
        "summary": "com.gigs.addon.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.addon.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.addon.published": {
      "post": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "com.gigs.addon.published",
        "summary": "com.gigs.addon.published",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.addon.published"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.published",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.published",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.addon.updated": {
      "post": {
        "tags": [
          "Add-ons"
        ],
        "operationId": "com.gigs.addon.updated",
        "summary": "com.gigs.addon.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.addon.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7,
                        "totalPeriods": 1
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "addon",
                      "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:12:28Z",
                      "description": "Disable international roaming.",
                      "limits": {
                        "dataBytes": 13000000000,
                        "throttling": {
                          "thresholdBytes": 3000000000,
                          "bandwidthBitsPerSecond": 256000
                        }
                      },
                      "name": "1GB Data Top-up",
                      "plans": [
                        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      ],
                      "price": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "provider": "p5",
                      "recurrenceType": "oneTime",
                      "status": "draft",
                      "type": "topUp",
                      "validity": {
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.addon.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.connectSession.created": {
      "post": {
        "tags": [
          "Connect Sessions"
        ],
        "operationId": "com.gigs.connectSession.created",
        "summary": "com.gigs.connectSession.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.connectSession.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "connectSession",
                      "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
                      "appearance": {
                        "theme": "light"
                      },
                      "callbackUrl": "https://example.com",
                      "intent": {
                        "browseDataPackages": {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        },
                        "cancelSubscription": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "changeSubscription": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "checkoutAddon": {
                          "addons": [
                            "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
                          ],
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "checkoutNewSubscription": {
                          "device": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "imei": "492388841798923",
                          "voucherCode": "PROMO10"
                        },
                        "completePorting": {
                          "behavior": {
                            "hideIntroPage": true,
                            "hideOutroPage": true
                          },
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "confirmPayment": {
                          "payment": "pay_0SNlurA049MEWV2HRA0slWFuS8DV"
                        },
                        "evergreenRoaming": {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "entryPoint": "browseDataPackages"
                        },
                        "manageDataPackages": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "replaceSim": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "requestSupport": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "resumeSubscription": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "type": "browseDataPackages",
                        "viewEsimInstallation": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "entryPoint": "manual"
                        },
                        "viewSubscription": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        }
                      },
                      "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.connectSession.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "connectSession",
                      "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
                      "appearance": {},
                      "callbackUrl": "https://example.com",
                      "intent": {
                        "type": "browseDataPackages"
                      },
                      "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.connectSession.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.connectSession.updated": {
      "post": {
        "tags": [
          "Connect Sessions"
        ],
        "operationId": "com.gigs.connectSession.updated",
        "summary": "com.gigs.connectSession.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.connectSession.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "connectSession",
                      "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
                      "appearance": {
                        "theme": "light"
                      },
                      "callbackUrl": "https://example.com",
                      "intent": {
                        "browseDataPackages": {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        },
                        "cancelSubscription": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "changeSubscription": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "checkoutAddon": {
                          "addons": [
                            "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
                          ],
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "checkoutNewSubscription": {
                          "device": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "imei": "492388841798923",
                          "voucherCode": "PROMO10"
                        },
                        "completePorting": {
                          "behavior": {
                            "hideIntroPage": true,
                            "hideOutroPage": true
                          },
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "confirmPayment": {
                          "payment": "pay_0SNlurA049MEWV2HRA0slWFuS8DV"
                        },
                        "evergreenRoaming": {
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "entryPoint": "browseDataPackages"
                        },
                        "manageDataPackages": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "replaceSim": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "requestSupport": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "resumeSubscription": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        },
                        "type": "browseDataPackages",
                        "viewEsimInstallation": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "entryPoint": "manual"
                        },
                        "viewSubscription": {
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                        }
                      },
                      "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.connectSession.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "connectSession",
                      "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
                      "appearance": {},
                      "callbackUrl": "https://example.com",
                      "intent": {
                        "type": "browseDataPackages"
                      },
                      "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.connectSession.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.consentRequest.approved": {
      "post": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "com.gigs.consentRequest.approved",
        "summary": "com.gigs.consentRequest.approved",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.consentRequest.approved"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.approved",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.approved",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.consentRequest.canceled": {
      "post": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "com.gigs.consentRequest.canceled",
        "summary": "com.gigs.consentRequest.canceled",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.consentRequest.canceled"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.canceled",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.canceled",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.consentRequest.created": {
      "post": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "com.gigs.consentRequest.created",
        "summary": "com.gigs.consentRequest.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.consentRequest.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.consentRequest.expired": {
      "post": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "com.gigs.consentRequest.expired",
        "summary": "com.gigs.consentRequest.expired",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.consentRequest.expired"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.expired",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.expired",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.consentRequest.updated": {
      "post": {
        "tags": [
          "Consent Requests"
        ],
        "operationId": "com.gigs.consentRequest.updated",
        "summary": "com.gigs.consentRequest.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.consentRequest.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "consentRequest",
                      "id": "crq_0SNlurA049MEWV2jN9EvAfKMf7VU",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "deliveryMethod": "emailLink",
                      "expiredAt": "2024-01-09T15:00:51Z",
                      "operation": "exchange.sim",
                      "status": "pending",
                      "subject": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.consentRequest.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.creditNote.created": {
      "post": {
        "tags": [
          "Credit Notes"
        ],
        "operationId": "com.gigs.creditNote.created",
        "summary": "com.gigs.creditNote.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.creditNote.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.creditNote.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.creditNote.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.creditNote.updated": {
      "post": {
        "tags": [
          "Credit Notes"
        ],
        "operationId": "com.gigs.creditNote.updated",
        "summary": "com.gigs.creditNote.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.creditNote.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.creditNote.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.creditNote.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.creditNote.voided": {
      "post": {
        "tags": [
          "Credit Notes"
        ],
        "operationId": "com.gigs.creditNote.voided",
        "summary": "com.gigs.creditNote.voided",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.creditNote.voided"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.creditNote.voided",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "creditNote",
                      "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
                      "metadata": {},
                      "createdAt": "2024-06-14T19:38:34Z",
                      "creditTo": "outOfBand",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123",
                      "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "lineItems": [
                        {
                          "amount": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                            }
                          ],
                          "total": {
                            "amount": 1199,
                            "currency": "USD"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-CN-2026-06-10001",
                      "status": "issued",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voidedAt": "2024-06-14T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.creditNote.voided",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.device.created": {
      "post": {
        "tags": [
          "Devices"
        ],
        "operationId": "com.gigs.device.created",
        "summary": "com.gigs.device.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.device.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.device.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.device.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.device.deleted": {
      "post": {
        "tags": [
          "Devices"
        ],
        "operationId": "com.gigs.device.deleted",
        "summary": "com.gigs.device.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.device.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.device.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.device.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.device.updated": {
      "post": {
        "tags": [
          "Devices"
        ],
        "operationId": "com.gigs.device.updated",
        "summary": "com.gigs.device.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.device.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.device.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "device",
                      "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
                      "metadata": {},
                      "createdAt": "2021-02-14T19:38:34Z",
                      "imei": "492388841798923",
                      "model": {
                        "object": "deviceModel",
                        "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
                        "brand": "Apple",
                        "hardwareIdentifiers": [
                          "SM-S928U1"
                        ],
                        "name": "iPhone 12 Pro",
                        "simTypes": [
                          "eSIM",
                          "pSIM"
                        ],
                        "type": "smartphone"
                      },
                      "name": "Anna's iPhone 12 Pro",
                      "sims": [
                        {
                          "object": "sim",
                          "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                          "metadata": {},
                          "createdAt": "2021-01-21T19:38:34Z",
                          "iccid": "89883070000007537119",
                          "provider": "p9",
                          "status": "inactive",
                          "suspension": null,
                          "type": "eSIM"
                        }
                      ],
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.device.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.eSimProfile.deleted": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.eSimProfile.deleted",
        "summary": "com.gigs.eSimProfile.deleted",
        "description": "Fires when the eSIM profile is deleted. Only available for providers `p3`, `p11`, `p14`, `p15` and `p18`.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.eSimProfile.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.eSimProfile.disabled": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.eSimProfile.disabled",
        "summary": "com.gigs.eSimProfile.disabled",
        "description": "Fires when the eSIM profile is disabled. Note that if the eSIM being\ndisabled results in the device losing connectivity, this event will be\ndelayed until connectivity is regained.\n\nOnly available for providers `p3`, `p11`, `p14`, `p15` and `p18`.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.eSimProfile.disabled"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.disabled",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.disabled",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.eSimProfile.downloadFailed": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.eSimProfile.downloadFailed",
        "summary": "com.gigs.eSimProfile.downloadFailed",
        "description": "Fires when the eSIM profile fails to download to a device. Only available for selected providers.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.eSimProfile.downloadFailed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.downloadFailed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.downloadFailed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.eSimProfile.downloaded": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.eSimProfile.downloaded",
        "summary": "com.gigs.eSimProfile.downloaded",
        "description": "Fires when the eSIM profile has been downloaded to a device, but not yet installed. Only available for providers `p11` and `p32`.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.eSimProfile.downloaded"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.downloaded",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.downloaded",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.eSimProfile.enabled": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.eSimProfile.enabled",
        "summary": "com.gigs.eSimProfile.enabled",
        "description": "Fires when the eSIM profile is enabled. Only available for providers `p3`, `p11`, `p12`, `p14`, `p15` and `p18`.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.eSimProfile.enabled"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.enabled",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.enabled",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.eSimProfile.installationFailed": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.eSimProfile.installationFailed",
        "summary": "com.gigs.eSimProfile.installationFailed",
        "description": "Fires when the eSIM profile fails to install on a device. Only available for selected providers.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.eSimProfile.installationFailed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.installationFailed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.installationFailed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.eSimProfile.installed": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.eSimProfile.installed",
        "summary": "com.gigs.eSimProfile.installed",
        "description": "Fires when the eSIM profile is installed on a device. Only available for providers `p3`, `p11`, `p12`, `p14`, `p15` and `p18`.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.eSimProfile.installed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.installed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.installed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.eSimProfile.updated": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.eSimProfile.updated",
        "summary": "com.gigs.eSimProfile.updated",
        "description": "Fires when the eSIM profile is updated. Only available for providers `p3`, `p11`, `p14`, `p15` and `p18`.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.eSimProfile.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "eSimProfile",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "deleted",
                      "updatedAt": "2024-03-13T15:36:01Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.eSimProfile.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.installation.created": {
      "post": {
        "tags": [
          "Installations"
        ],
        "operationId": "com.gigs.installation.created",
        "summary": "com.gigs.installation.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.installation.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "installation",
                      "application": "gigs-connect",
                      "createdAt": "2022-01-21T19:38:34Z",
                      "settings": {}
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.installation.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "installation",
                      "application": "gigs-connect",
                      "createdAt": "2022-01-21T19:38:34Z",
                      "settings": {}
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.installation.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.installation.updated": {
      "post": {
        "tags": [
          "Installations"
        ],
        "operationId": "com.gigs.installation.updated",
        "summary": "com.gigs.installation.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.installation.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "installation",
                      "application": "gigs-connect",
                      "createdAt": "2022-01-21T19:38:34Z",
                      "settings": {}
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.installation.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "installation",
                      "application": "gigs-connect",
                      "createdAt": "2022-01-21T19:38:34Z",
                      "settings": {}
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.installation.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.invoice.created": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "operationId": "com.gigs.invoice.created",
        "summary": "com.gigs.invoice.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.invoice.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "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": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "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": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.invoice.finalized": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "operationId": "com.gigs.invoice.finalized",
        "summary": "com.gigs.invoice.finalized",
        "description": "Triggered when an invoice is finalized and becomes due for payment.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.invoice.finalized"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.finalized",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.finalized",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.invoice.overdue": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "operationId": "com.gigs.invoice.overdue",
        "summary": "com.gigs.invoice.overdue",
        "description": "Triggered when an invoice becomes overdue and the overdue period starts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.invoice.overdue"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.overdue",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.overdue",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.invoice.paid": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "operationId": "com.gigs.invoice.paid",
        "summary": "com.gigs.invoice.paid",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.invoice.paid"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.paid",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.paid",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.invoice.updated": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "operationId": "com.gigs.invoice.updated",
        "summary": "com.gigs.invoice.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.invoice.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.invoice.voided": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "operationId": "com.gigs.invoice.voided",
        "summary": "com.gigs.invoice.voided",
        "description": "Triggered when an invoice is voided and can no longer be paid.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.invoice.voided"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.voided",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.voided",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.invoice.willBeOverdue": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "operationId": "com.gigs.invoice.willBeOverdue",
        "summary": "com.gigs.invoice.willBeOverdue",
        "description": "Triggered 24 hours before the overdue period starts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.invoice.willBeOverdue"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.willBeOverdue",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "invoice",
                      "id": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "appliedBalance": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "dueAt": "2024-02-01T11:12:13Z",
                      "expiresAt": "2024-02-11T11:13:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "fileUrl": "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123",
                      "finalizedAt": "2024-02-01T11:12:13Z",
                      "lineItems": [
                        {
                          "object": "invoiceLineItem",
                          "id": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                          "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                          "subscriptionChange": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                          "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"
                          }
                        }
                      ],
                      "number": "3l4rLP-DE-2026-06-10001",
                      "overdueAt": "2024-02-01T11:13:13Z",
                      "paidAt": "2024-02-01T11:13:13Z",
                      "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": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.invoice.willBeOverdue",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.created": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.created",
        "summary": "com.gigs.payment.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.disputeLost": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.disputeLost",
        "summary": "com.gigs.payment.disputeLost",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.disputeLost"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.disputeLost",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.disputeLost",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.disputeWon": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.disputeWon",
        "summary": "com.gigs.payment.disputeWon",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.disputeWon"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.disputeWon",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.disputeWon",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.disputed": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.disputed",
        "summary": "com.gigs.payment.disputed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.disputed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.disputed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.disputed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.failed": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.failed",
        "summary": "com.gigs.payment.failed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.failed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.failed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.failed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.paymentMethod.confirmed": {
      "post": {
        "tags": [
          "Payment Methods"
        ],
        "operationId": "com.gigs.paymentMethod.confirmed",
        "summary": "com.gigs.paymentMethod.confirmed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.paymentMethod.confirmed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "paymentMethod",
                      "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                      "brand": "visa",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "last4": "4242",
                      "provider": "stripe",
                      "status": "available",
                      "type": "card",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.paymentMethod.confirmed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "paymentMethod",
                      "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                      "brand": "visa",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "last4": "4242",
                      "provider": "stripe",
                      "status": "available",
                      "type": "card",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.paymentMethod.confirmed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.paymentMethod.created": {
      "post": {
        "tags": [
          "Payment Methods"
        ],
        "operationId": "com.gigs.paymentMethod.created",
        "summary": "com.gigs.paymentMethod.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.paymentMethod.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "paymentMethod",
                      "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                      "brand": "visa",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "last4": "4242",
                      "provider": "stripe",
                      "status": "available",
                      "type": "card",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.paymentMethod.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "paymentMethod",
                      "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                      "brand": "visa",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "last4": "4242",
                      "provider": "stripe",
                      "status": "available",
                      "type": "card",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.paymentMethod.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.paymentMethod.deleted": {
      "post": {
        "tags": [
          "Payment Methods"
        ],
        "operationId": "com.gigs.paymentMethod.deleted",
        "summary": "com.gigs.paymentMethod.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.paymentMethod.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "paymentMethod",
                      "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                      "brand": "visa",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "last4": "4242",
                      "provider": "stripe",
                      "status": "available",
                      "type": "card",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.paymentMethod.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "paymentMethod",
                      "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                      "brand": "visa",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "last4": "4242",
                      "provider": "stripe",
                      "status": "available",
                      "type": "card",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.paymentMethod.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.paymentMethodRequired": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.paymentMethodRequired",
        "summary": "com.gigs.payment.paymentMethodRequired",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.paymentMethodRequired"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.paymentMethodRequired",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.paymentMethodRequired",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.refunded": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.refunded",
        "summary": "com.gigs.payment.refunded",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.refunded"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.refunded",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.refunded",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.requiresConfirmation": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.requiresConfirmation",
        "summary": "com.gigs.payment.requiresConfirmation",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.requiresConfirmation"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.requiresConfirmation",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.requiresConfirmation",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.payment.succeeded": {
      "post": {
        "tags": [
          "Payments"
        ],
        "operationId": "com.gigs.payment.succeeded",
        "summary": "com.gigs.payment.succeeded",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.payment.succeeded"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.succeeded",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "payment",
                      "id": "pay_0SNlurA049MEWV2HRA0slWFuS8DV",
                      "amount": {
                        "amount": 990,
                        "currency": "USD"
                      },
                      "attemptedAt": "2021-02-14T19:38:34Z",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "disputeClosedAt": "2021-02-14T19:38:34Z",
                      "disputeOutcome": null,
                      "failedAttempts": 3,
                      "failureCode": "paymentCardDeclined",
                      "failureMessage": "The card has been declined.",
                      "method": {
                        "object": "paymentMethod",
                        "id": "pm_1IHCiiI2m82Dc6YnhqGWH6JX",
                        "brand": "visa",
                        "createdAt": "2021-02-14T19:38:34Z",
                        "last4": "4242",
                        "provider": "stripe",
                        "status": "available",
                        "type": "card",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "reason": "subscriptionCreation",
                      "references": [
                        {
                          "object": "order",
                          "id": "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                        }
                      ],
                      "refunded": {
                        "amount": 0,
                        "currency": "USD"
                      },
                      "refundedAt": "2021-02-14T19:38:34Z",
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.payment.succeeded",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.plan.archived": {
      "post": {
        "tags": [
          "Plans"
        ],
        "operationId": "com.gigs.plan.archived",
        "summary": "com.gigs.plan.archived",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.plan.archived"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.archived",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.archived",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.plan.created": {
      "post": {
        "tags": [
          "Plans"
        ],
        "operationId": "com.gigs.plan.created",
        "summary": "com.gigs.plan.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.plan.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.plan.deleted": {
      "post": {
        "tags": [
          "Plans"
        ],
        "operationId": "com.gigs.plan.deleted",
        "summary": "com.gigs.plan.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.plan.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.plan.published": {
      "post": {
        "tags": [
          "Plans"
        ],
        "operationId": "com.gigs.plan.published",
        "summary": "com.gigs.plan.published",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.plan.published"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.published",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.published",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.plan.updated": {
      "post": {
        "tags": [
          "Plans"
        ],
        "operationId": "com.gigs.plan.updated",
        "summary": "com.gigs.plan.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.plan.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "plan",
                      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "metadata": {},
                      "activationTrigger": "creation",
                      "allowances": {
                        "dataBytes": 10000000000,
                        "voiceSeconds": 30000,
                        "smsMessages": 100
                      },
                      "coverage": {
                        "object": "coverage",
                        "id": "de",
                        "countries": [
                          "DE",
                          "FR",
                          "US"
                        ],
                        "name": "Europe"
                      },
                      "createdAt": "2021-01-21T19:38:34Z",
                      "description": "A data plan you will love! Operates in most countries of the world.",
                      "firstPeriodTrigger": "creation",
                      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                      "limits": {
                        "dataBytes": 100000000000,
                        "bandwidthBitsPerSecond": 100000000,
                        "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"
                      ],
                      "status": "available",
                      "validity": {
                        "minimumPeriods": 12,
                        "type": "recurring",
                        "unit": "day",
                        "value": 7
                      },
                      "data": 10000000000,
                      "dataUnit": "byte",
                      "sms": 100,
                      "smsUnit": "message",
                      "voice": 30000,
                      "voiceUnit": "second"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.plan.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.portOut.completed": {
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "com.gigs.portOut.completed",
        "summary": "com.gigs.portOut.completed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.portOut.completed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.completed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.completed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.portOut.created": {
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "com.gigs.portOut.created",
        "summary": "com.gigs.portOut.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.portOut.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.portOutCredentials.issued": {
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "com.gigs.portOutCredentials.issued",
        "summary": "com.gigs.portOutCredentials.issued",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.portOutCredentials.issued"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOutCredentials",
                      "accountNumber": "123456789",
                      "accountPin": "1234",
                      "behavior": "portOut",
                      "expiresAt": "2022-02-21T19:38:34Z",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOutCredentials.issued",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOutCredentials",
                      "accountNumber": "123456789",
                      "accountPin": "1234",
                      "behavior": "portOut",
                      "expiresAt": "2022-02-21T19:38:34Z",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOutCredentials.issued",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "deprecated": true,
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.portOut.expired": {
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "com.gigs.portOut.expired",
        "summary": "com.gigs.portOut.expired",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.portOut.expired"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.expired",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.expired",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.portOut.failed": {
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "com.gigs.portOut.failed",
        "summary": "com.gigs.portOut.failed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.portOut.failed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.failed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.failed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.portOut.issued": {
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "com.gigs.portOut.issued",
        "summary": "com.gigs.portOut.issued",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.portOut.issued"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.issued",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.issued",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.portOut.processing": {
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "com.gigs.portOut.processing",
        "summary": "com.gigs.portOut.processing",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.portOut.processing"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.processing",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.processing",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.portOut.updated": {
      "post": {
        "tags": [
          "Port Outs"
        ],
        "operationId": "com.gigs.portOut.updated",
        "summary": "com.gigs.portOut.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.portOut.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "portOut",
                      "id": "pto_0SNlurA049MEWV4DWEaT4SaeDI8s",
                      "behavior": "portOut",
                      "completedAt": "2022-02-21T19:38:34Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "expirationRequestedAt": "2022-02-21T19:38:12Z",
                      "expiredAt": "2022-02-21T19:38:34Z",
                      "failureReason": "consentNotGiven",
                      "status": "issued",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.portOut.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.canceled": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.canceled",
        "summary": "com.gigs.porting.canceled",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.canceled"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.canceled",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.canceled",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.completed": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.completed",
        "summary": "com.gigs.porting.completed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.completed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.completed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.completed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.created": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.created",
        "summary": "com.gigs.porting.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.declined": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.declined",
        "summary": "com.gigs.porting.declined",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.declined"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.declined",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.declined",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.deleted": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.deleted",
        "summary": "com.gigs.porting.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.expired": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.expired",
        "summary": "com.gigs.porting.expired",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.expired"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.expired",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.expired",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.failed": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.failed",
        "summary": "com.gigs.porting.failed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.failed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.failed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.failed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.informationRequired": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.informationRequired",
        "summary": "com.gigs.porting.informationRequired",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.informationRequired"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.informationRequired",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.informationRequired",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.requested": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.requested",
        "summary": "com.gigs.porting.requested",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.requested"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.requested",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.requested",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.porting.updated": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.porting.updated",
        "summary": "com.gigs.porting.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.porting.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "porting",
                      "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                      "accountNumber": "123456789",
                      "accountPinExists": true,
                      "accountType": "prepaidUnregistered",
                      "address": {
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "behavior": "portIn",
                      "billingPinExists": true,
                      "birthday": "2017-07-21",
                      "canceledAt": "2021-01-21T19:39:53Z",
                      "completedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "declinedAttempts": 0,
                      "declinedCode": "portingPhoneNumberPortProtected",
                      "declinedMessage": "The phone number has port protection on the provider.",
                      "donorProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "donorProviderApproval": true,
                      "expiredAt": "2021-01-21T19:39:53Z",
                      "failedAt": "2021-01-21T19:39:53Z",
                      "failureReason": "consentNotGiven",
                      "firstName": "Jerry",
                      "lastDeclinedAt": "2021-01-21T19:31:13Z",
                      "lastName": "Seinfeld",
                      "lastRequestedAt": "2021-01-21T19:22:31Z",
                      "phoneNumber": "+19591234567",
                      "provider": "p9",
                      "recipientProvider": {
                        "object": "serviceProvider",
                        "id": "svp_0SNlurA01K6GY5L0XJffY8",
                        "country": "US",
                        "name": "AT&T",
                        "recipientProviders": [
                          "p3"
                        ]
                      },
                      "requestBehavior": "automatic",
                      "required": [
                        "accountNumber",
                        "accountPin",
                        "accountType",
                        "address",
                        "birthday",
                        "donorProvider",
                        "donorProviderApproval",
                        "firstName",
                        "lastName"
                      ],
                      "scheduledOn": "2021-01-21",
                      "status": "draft",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.porting.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.project.created": {
      "post": {
        "tags": [
          "Projects"
        ],
        "operationId": "com.gigs.project.created",
        "summary": "com.gigs.project.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.project.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {
                        "deliveryMethods": [
                          "emailLink"
                        ],
                        "approvalBaseUrl": "https://consent.gigs.com/consent"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.project.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.project.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.project.deleted": {
      "post": {
        "tags": [
          "Projects"
        ],
        "operationId": "com.gigs.project.deleted",
        "summary": "com.gigs.project.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.project.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {
                        "deliveryMethods": [
                          "emailLink"
                        ],
                        "approvalBaseUrl": "https://consent.gigs.com/consent"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.project.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.project.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.project.restored": {
      "post": {
        "tags": [
          "Projects"
        ],
        "operationId": "com.gigs.project.restored",
        "summary": "com.gigs.project.restored",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.project.restored"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {
                        "deliveryMethods": [
                          "emailLink"
                        ],
                        "approvalBaseUrl": "https://consent.gigs.com/consent"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.project.restored",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.project.restored",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.project.updated": {
      "post": {
        "tags": [
          "Projects"
        ],
        "operationId": "com.gigs.project.updated",
        "summary": "com.gigs.project.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.project.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {
                        "deliveryMethods": [
                          "emailLink"
                        ],
                        "approvalBaseUrl": "https://consent.gigs.com/consent"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.project.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "project",
                      "id": "gigs",
                      "billing": {
                        "advanceInvoicingDays": 7,
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverdueDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": "end",
                        "currency": "USD",
                        "restrictBehavior": null,
                        "restoreBehavior": null,
                        "paymentBehavior": "manual",
                        "taxBehavior": "exclusive",
                        "recoveryFeePercentage": 10.0,
                        "recoveryFeeAmount": {
                          "amount": 150,
                          "currency": "USD"
                        }
                      },
                      "consent": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "image": "https://a.gigscdn.net/p/gigs/icon.png",
                      "legal": {
                        "name": "Gigs Inc.",
                        "city": "New York City",
                        "country": "US",
                        "line1": "129 West 81st Street",
                        "line2": "Apartment 5",
                        "postalCode": "10024",
                        "state": "NY"
                      },
                      "locales": [
                        "en-US"
                      ],
                      "name": "Gigs Connect",
                      "organization": {
                        "object": "organization",
                        "id": "org_0SNlurA04kOdemVEMVZQBF",
                        "createdAt": "2021-02-01T13:21:30Z",
                        "name": "Gigs"
                      },
                      "payments": {
                        "currency": "USD",
                        "mode": "live"
                      },
                      "subscriptionOwner": "user",
                      "support": {
                        "email": "support@gigs.com",
                        "phoneNumber": "+12345678900"
                      },
                      "tax": {
                        "country": "US"
                      },
                      "type": "live"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.project.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.quote.created": {
      "post": {
        "tags": [
          "Quotes"
        ],
        "operationId": "com.gigs.quote.created",
        "summary": "com.gigs.quote.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.quote.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "quote",
                      "id": "quo_0SNlurA049MEWV2X9NicYieFQ4Kc",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "expiredAt": "2024-02-01T11:12:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "lineItems": [
                        {
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subtotal": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "inclusive": false,
                              "jurisdiction": "Federal",
                              "name": "Federal TRS Fund"
                            }
                          ],
                          "total": {
                            "amount": 1099,
                            "currency": "USD"
                          }
                        }
                      ],
                      "reason": "other",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.quote.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "quote",
                      "id": "quo_0SNlurA049MEWV2X9NicYieFQ4Kc",
                      "address": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "createdAt": "2024-01-09T15:00:51Z",
                      "discount": {
                        "amount": 100,
                        "currency": "USD"
                      },
                      "expiredAt": "2024-02-01T11:12:13Z",
                      "fees": [
                        {
                          "amount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "name": "Recovery Fee",
                          "type": "recoveryFee"
                        }
                      ],
                      "lineItems": [
                        {
                          "addon": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                          "creditedPlan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "discount": {
                            "amount": 100,
                            "currency": "USD"
                          },
                          "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                          "subtotal": {
                            "amount": 999,
                            "currency": "USD"
                          },
                          "tax": {
                            "amount": 200,
                            "currency": "USD"
                          },
                          "taxes": [
                            {
                              "amount": {
                                "amount": 200,
                                "currency": "USD"
                              },
                              "inclusive": false,
                              "jurisdiction": "Federal",
                              "name": "Federal TRS Fund"
                            }
                          ],
                          "total": {
                            "amount": 1099,
                            "currency": "USD"
                          }
                        }
                      ],
                      "reason": "other",
                      "subtotal": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "tax": {
                        "amount": 200,
                        "currency": "USD"
                      },
                      "taxExemptionReason": "calculationFailed",
                      "total": {
                        "amount": 1199,
                        "currency": "USD"
                      },
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.quote.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.roaming.ended": {
      "post": {
        "tags": [
          "Roaming"
        ],
        "operationId": "com.gigs.roaming.ended",
        "summary": "com.gigs.roaming.ended",
        "description": "Fires when a subscription stops roaming in the country it was last seen\nroaming in.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.roaming.ended"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "roaming",
                      "countries": [
                        "DE"
                      ],
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "startedAt": "2021-02-14T00:00:00Z",
                      "endedAt": "2021-02-14T00:00:00Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.roaming.ended",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "roaming",
                      "countries": [
                        "DE"
                      ],
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "startedAt": "2021-02-14T00:00:00Z",
                      "endedAt": "2021-02-14T00:00:00Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.roaming.ended",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.roaming.started": {
      "post": {
        "tags": [
          "Roaming"
        ],
        "operationId": "com.gigs.roaming.started",
        "summary": "com.gigs.roaming.started",
        "description": "Fires when a subscription is seen on a network in a country it was not\nalready roaming in.\n\nConsecutive connections to a network in the same country do not fire a\nnew event.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.roaming.started"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "roaming",
                      "countries": [
                        "DE"
                      ],
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "startedAt": "2021-02-14T00:00:00Z",
                      "endedAt": "2021-02-14T00:00:00Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.roaming.started",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "roaming",
                      "countries": [
                        "DE"
                      ],
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "startedAt": "2021-02-14T00:00:00Z",
                      "endedAt": "2021-02-14T00:00:00Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.roaming.started",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.sim.activated": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.sim.activated",
        "summary": "com.gigs.sim.activated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.sim.activated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.activated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.activated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.sim.created": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.sim.created",
        "summary": "com.gigs.sim.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.sim.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.sim.deactivated": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.sim.deactivated",
        "summary": "com.gigs.sim.deactivated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.sim.deactivated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.deactivated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.deactivated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.sim.deleted": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.sim.deleted",
        "summary": "com.gigs.sim.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.sim.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.sim.retired": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.sim.retired",
        "summary": "com.gigs.sim.retired",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.sim.retired"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.retired",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.retired",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.sim.suspended": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.sim.suspended",
        "summary": "com.gigs.sim.suspended",
        "description": "Triggered when the network provider confirms a SIM's suspension. A suspended SIM has no voice, SMS or data.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.sim.suspended"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.suspended",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.suspended",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.sim.unsuspended": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.sim.unsuspended",
        "summary": "com.gigs.sim.unsuspended",
        "description": "Triggered when the network provider confirms that a SIM is unsuspended, restoring voice, SMS and data.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.sim.unsuspended"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.unsuspended",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.unsuspended",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.sim.updated": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.sim.updated",
        "summary": "com.gigs.sim.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.sim.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "sim",
                      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                      "metadata": {},
                      "createdAt": "2021-01-21T19:38:34Z",
                      "iccid": "89883070000007537119",
                      "provider": "p9",
                      "status": "inactive",
                      "suspension": null,
                      "type": "eSIM"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.sim.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.activated": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.activated",
        "summary": "com.gigs.subscription.activated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.activated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.activated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.activated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionAddon.activated": {
      "post": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "com.gigs.subscriptionAddon.activated",
        "summary": "com.gigs.subscriptionAddon.activated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionAddon.activated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7,
                          "totalPeriods": 1
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.activated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.activated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionAddon.created": {
      "post": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "com.gigs.subscriptionAddon.created",
        "summary": "com.gigs.subscriptionAddon.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionAddon.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7,
                          "totalPeriods": 1
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionAddon.ended": {
      "post": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "com.gigs.subscriptionAddon.ended",
        "summary": "com.gigs.subscriptionAddon.ended",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionAddon.ended"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7,
                          "totalPeriods": 1
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.ended",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.ended",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionAddon.resumed": {
      "post": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "com.gigs.subscriptionAddon.resumed",
        "summary": "com.gigs.subscriptionAddon.resumed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionAddon.resumed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7,
                          "totalPeriods": 1
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.resumed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.resumed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionAddon.updated": {
      "post": {
        "tags": [
          "Subscription Add-ons"
        ],
        "operationId": "com.gigs.subscriptionAddon.updated",
        "summary": "com.gigs.subscriptionAddon.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionAddon.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7,
                          "totalPeriods": 1
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionAddon",
                      "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
                      "activatedAt": "2021-01-15T12:36:57Z",
                      "addon": {
                        "object": "addon",
                        "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:12:28Z",
                        "description": "Disable international roaming.",
                        "limits": {
                          "dataBytes": 13000000000,
                          "throttling": {
                            "thresholdBytes": 3000000000,
                            "bandwidthBitsPerSecond": 256000
                          }
                        },
                        "name": "1GB Data Top-up",
                        "plans": [
                          "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                        ],
                        "price": {
                          "amount": 999,
                          "currency": "USD"
                        },
                        "provider": "p5",
                        "recurrenceType": "oneTime",
                        "status": "draft",
                        "type": "topUp",
                        "validity": {
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        }
                      },
                      "canceledAt": "2021-01-22T19:39:53Z",
                      "createdAt": "2021-01-15T12:30:28Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "endedAt": "2021-01-30T23:12:28Z",
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionAddon.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.canceled": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.canceled",
        "summary": "com.gigs.subscription.canceled",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.canceled"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.canceled",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.canceled",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionChange.applied": {
      "post": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "com.gigs.subscriptionChange.applied",
        "summary": "com.gigs.subscriptionChange.applied",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionChange.applied"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.applied",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.applied",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionChange.created": {
      "post": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "com.gigs.subscriptionChange.created",
        "summary": "com.gigs.subscriptionChange.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionChange.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionChange.deleted": {
      "post": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "com.gigs.subscriptionChange.deleted",
        "summary": "com.gigs.subscriptionChange.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionChange.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionChange.failed": {
      "post": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "com.gigs.subscriptionChange.failed",
        "summary": "com.gigs.subscriptionChange.failed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionChange.failed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.failed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.failed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionChange.pending": {
      "post": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "com.gigs.subscriptionChange.pending",
        "summary": "com.gigs.subscriptionChange.pending",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionChange.pending"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.pending",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.pending",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionChange.updated": {
      "post": {
        "tags": [
          "Subscription Changes"
        ],
        "operationId": "com.gigs.subscriptionChange.updated",
        "summary": "com.gigs.subscriptionChange.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionChange.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionChange",
                      "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
                      "appliedAt": "2021-01-21T19:36:57Z",
                      "createdAt": "2021-01-21T19:12:28Z",
                      "failureCode": "consentNotGiven",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "requestedChange": {
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "phoneNumber": "auto",
                        "when": "renewal"
                      },
                      "scheduledAt": "2021-01-21T19:12:28Z",
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionChange.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.created": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.created",
        "summary": "com.gigs.subscription.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.ended": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.ended",
        "summary": "com.gigs.subscription.ended",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.ended"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.ended",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.ended",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionGroup.created": {
      "post": {
        "tags": [
          "Subscription Groups"
        ],
        "operationId": "com.gigs.subscriptionGroup.created",
        "summary": "com.gigs.subscriptionGroup.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionGroup.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionGroup",
                      "id": "sgr_0SNlurA049MEWV26leJMWPp4o23C",
                      "subscriptions": [
                        "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                      ],
                      "type": "familyPlan",
                      "status": "active",
                      "discountGroup": {},
                      "familyPlan": {
                        "primarySubscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      },
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "createdAt": "2021-01-21T19:32:13Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionGroup.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionGroup",
                      "id": "sgr_0SNlurA049MEWV26leJMWPp4o23C",
                      "subscriptions": [
                        "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                      ],
                      "type": "familyPlan",
                      "status": "active",
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "createdAt": "2021-01-21T19:32:13Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionGroup.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionGroup.deleted": {
      "post": {
        "tags": [
          "Subscription Groups"
        ],
        "operationId": "com.gigs.subscriptionGroup.deleted",
        "summary": "com.gigs.subscriptionGroup.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionGroup.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionGroup",
                      "id": "sgr_0SNlurA049MEWV26leJMWPp4o23C",
                      "subscriptions": [
                        "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                      ],
                      "type": "familyPlan",
                      "status": "active",
                      "discountGroup": {},
                      "familyPlan": {
                        "primarySubscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      },
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "createdAt": "2021-01-21T19:32:13Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionGroup.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionGroup",
                      "id": "sgr_0SNlurA049MEWV26leJMWPp4o23C",
                      "subscriptions": [
                        "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                      ],
                      "type": "familyPlan",
                      "status": "active",
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "createdAt": "2021-01-21T19:32:13Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionGroup.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscriptionGroup.updated": {
      "post": {
        "tags": [
          "Subscription Groups"
        ],
        "operationId": "com.gigs.subscriptionGroup.updated",
        "summary": "com.gigs.subscriptionGroup.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscriptionGroup.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionGroup",
                      "id": "sgr_0SNlurA049MEWV26leJMWPp4o23C",
                      "subscriptions": [
                        "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                      ],
                      "type": "familyPlan",
                      "status": "active",
                      "discountGroup": {},
                      "familyPlan": {
                        "primarySubscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                      },
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "createdAt": "2021-01-21T19:32:13Z"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionGroup.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscriptionGroup",
                      "id": "sgr_0SNlurA049MEWV26leJMWPp4o23C",
                      "subscriptions": [
                        "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                      ],
                      "type": "familyPlan",
                      "status": "active",
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "createdAt": "2021-01-21T19:32:13Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscriptionGroup.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.renewed": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.renewed",
        "summary": "com.gigs.subscription.renewed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.renewed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.renewed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.renewed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.restored": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.restored",
        "summary": "com.gigs.subscription.restored",
        "description": "Triggered when a subscription is restored after being previously restricted (for example, after paying an overdue invoice).",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.restored"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.restored",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.restored",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.restricted": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.restricted",
        "summary": "com.gigs.subscription.restricted",
        "description": "Triggered when a subscription is restricted due to, for example, an overdue invoice.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.restricted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.restricted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.restricted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.resumed": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.resumed",
        "summary": "com.gigs.subscription.resumed",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.resumed"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.resumed",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.resumed",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.subscription.updated": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.subscription.updated",
        "summary": "com.gigs.subscription.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.subscription.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {
                        "cause": "cancellationRequested",
                        "userReason": "connectivityIssues"
                      },
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "subscription",
                      "id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "metadata": {},
                      "activatedAt": "2021-01-21T19:38:34Z",
                      "billing": {
                        "discount": {
                          "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                          "expiresAt": "2021-02-20T19:38:34Z"
                        },
                        "invoiceGracePeriodDays": 3,
                        "invoiceOverduePeriodDays": 1,
                        "invoiceOverdueAction": null,
                        "restrictBehavior": null,
                        "restoreBehavior": null
                      },
                      "canceledAt": "2021-01-29T13:22:51Z",
                      "cancellationDetails": {},
                      "createdAt": "2021-01-21T19:32:13Z",
                      "currentPeriod": {
                        "number": 1,
                        "start": "2021-01-21T19:32:13Z",
                        "end": "2021-02-20T19:38:34Z"
                      },
                      "earliestEndAt": "2021-02-20T19:38:34Z",
                      "endedAt": "2021-02-20T19:38:34Z",
                      "firstUsageAt": "2021-01-21T19:38:34Z",
                      "lastPorting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      },
                      "phoneNumber": "+19591234567",
                      "plan": {
                        "object": "plan",
                        "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                        "metadata": {},
                        "activationTrigger": "creation",
                        "allowances": {
                          "dataBytes": 10000000000,
                          "voiceSeconds": 30000,
                          "smsMessages": 100
                        },
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "createdAt": "2021-01-21T19:38:34Z",
                        "description": "A data plan you will love! Operates in most countries of the world.",
                        "firstPeriodTrigger": "creation",
                        "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
                        "limits": {
                          "dataBytes": 100000000000,
                          "bandwidthBitsPerSecond": 100000000,
                          "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"
                        ],
                        "status": "available",
                        "validity": {
                          "minimumPeriods": 12,
                          "type": "recurring",
                          "unit": "day",
                          "value": 7
                        },
                        "data": 10000000000,
                        "dataUnit": "byte",
                        "sms": 100,
                        "smsUnit": "message",
                        "voice": 30000,
                        "voiceUnit": "second"
                      },
                      "restoreRequestedAt": "2021-02-21T19:38:34Z",
                      "restrictedAt": "2021-02-21T19:38:34Z",
                      "restrictionDetails": {
                        "restrictBehavior": "incomingOnly",
                        "restoreBehavior": "resetPeriodAnchor",
                        "cause": "invoiceOverdue"
                      },
                      "sim": {
                        "object": "sim",
                        "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
                        "metadata": {},
                        "createdAt": "2021-01-21T19:38:34Z",
                        "iccid": "89883070000007537119",
                        "provider": "p9",
                        "status": "inactive",
                        "suspension": null,
                        "type": "eSIM"
                      },
                      "status": "pending",
                      "user": {
                        "object": "user",
                        "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                        "metadata": {},
                        "birthday": "2017-07-21",
                        "createdAt": "2021-01-21T19:38:34Z",
                        "email": "jerry@example.com",
                        "emailVerified": true,
                        "fullName": "Jerry Seinfeld",
                        "preferredLocale": "en-US",
                        "status": "active"
                      },
                      "userAddress": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "porting": {
                        "object": "porting",
                        "id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
                        "accountNumber": "123456789",
                        "accountPinExists": true,
                        "accountType": "prepaidUnregistered",
                        "address": {
                          "city": "New York City",
                          "country": "US",
                          "line1": "129 West 81st Street",
                          "line2": "Apartment 5",
                          "postalCode": "10024",
                          "state": "NY"
                        },
                        "behavior": "portIn",
                        "billingPinExists": true,
                        "birthday": "2017-07-21",
                        "canceledAt": "2021-01-21T19:39:53Z",
                        "completedAt": "2021-01-21T19:36:57Z",
                        "createdAt": "2021-01-21T19:12:28Z",
                        "declinedAttempts": 0,
                        "declinedCode": "portingPhoneNumberPortProtected",
                        "declinedMessage": "The phone number has port protection on the provider.",
                        "donorProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "donorProviderApproval": true,
                        "expiredAt": "2021-01-21T19:39:53Z",
                        "failedAt": "2021-01-21T19:39:53Z",
                        "failureReason": "consentNotGiven",
                        "firstName": "Jerry",
                        "lastDeclinedAt": "2021-01-21T19:31:13Z",
                        "lastName": "Seinfeld",
                        "lastRequestedAt": "2021-01-21T19:22:31Z",
                        "phoneNumber": "+19591234567",
                        "provider": "p9",
                        "recipientProvider": {
                          "object": "serviceProvider",
                          "id": "svp_0SNlurA01K6GY5L0XJffY8",
                          "country": "US",
                          "name": "AT&T",
                          "recipientProviders": [
                            "p3"
                          ]
                        },
                        "requestBehavior": "automatic",
                        "required": [
                          "accountNumber",
                          "accountPin",
                          "accountType",
                          "address",
                          "birthday",
                          "donorProvider",
                          "donorProviderApproval",
                          "firstName",
                          "lastName"
                        ],
                        "scheduledOn": "2021-01-21",
                        "status": "draft",
                        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                        "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                      }
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.subscription.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.usageBalance.thresholdReached": {
      "post": {
        "tags": [
          "Usage Balances"
        ],
        "operationId": "com.gigs.usageBalance.thresholdReached",
        "summary": "com.gigs.usageBalance.thresholdReached",
        "description": "Fires when usage reaches one of the predefined thresholds: 50%, 70%, 90%, or 100%.\nIf several thresholds are reached at the same time, the event fires only for the highest one.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.usageBalance.thresholdReached"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "usageBalance",
                      "id": "ubl_0V9n0zo90CE0NuvcsN0j88",
                      "allowance": {
                        "object": "allowance",
                        "id": "alw_0SNlurA049MEWV3OMTRrGKbd99GH",
                        "name": "Roaming data in Europe",
                        "type": "data",
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "limit": 500,
                        "unit": "bytes"
                      },
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "source": {
                        "type": "subscriptionPeriod",
                        "subscriptionPeriod": 4,
                        "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                      },
                      "unit": "bytes",
                      "used": 230,
                      "limit": 500,
                      "remaining": 270,
                      "usedPercent": 46,
                      "remainingPercent": 54,
                      "usableFrom": "2026-01-03T13:41:24Z",
                      "usableUntil": "2026-02-03T13:41:24Z",
                      "updatedAt": "2026-01-15T08:12:51Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.usageBalance.thresholdReached",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "usageBalance",
                      "id": "ubl_0V9n0zo90CE0NuvcsN0j88",
                      "allowance": {
                        "object": "allowance",
                        "id": "alw_0SNlurA049MEWV3OMTRrGKbd99GH",
                        "name": "Roaming data in Europe",
                        "type": "data",
                        "coverage": {
                          "object": "coverage",
                          "id": "de",
                          "countries": [
                            "DE",
                            "FR",
                            "US"
                          ],
                          "name": "Europe"
                        },
                        "limit": 500,
                        "unit": "bytes"
                      },
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "source": {
                        "type": "subscriptionPeriod"
                      },
                      "unit": "bytes",
                      "used": 230,
                      "limit": 500,
                      "remaining": 270,
                      "usedPercent": 46,
                      "remainingPercent": 54,
                      "usableFrom": "2026-01-03T13:41:24Z",
                      "usableUntil": "2026-02-03T13:41:24Z",
                      "updatedAt": "2026-01-15T08:12:51Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.usageBalance.thresholdReached",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.usageNotification.created": {
      "post": {
        "tags": [
          "Usage"
        ],
        "operationId": "com.gigs.usageNotification.created",
        "summary": "com.gigs.usageNotification.created",
        "description": "Triggered when a new usage notification is created.\n\nThe currently-supported types of usage notification are:\n\n  - `started`, which is fired when the `subscription` is first used.\n  - `throttled`, which is fired when the `subscription` has had its data\n    usage throttled to a lower bandwidth.\n  - `thresholdExceeded`, which is fired when the `subscription` has used\n    70%, 90% and 100% of its `data`, `sms` or `voice` allowance.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.usageNotification.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "usageNotification",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "thresholdExceeded": {
                        "type": "data",
                        "at": "2024-02-29T14:01:12Z",
                        "data": {
                          "allowanceBytes": 10000000000,
                          "usageBytes": 7000000000
                        },
                        "percentage": 70,
                        "roaming": "none",
                        "dataDevice": {
                          "allowanceBytes": 5000000000,
                          "usageBytes": 3500000000
                        },
                        "dataTethering": {
                          "allowanceBytes": 5000000000,
                          "usageBytes": 3500000000
                        },
                        "voiceInternational": {
                          "allowanceSeconds": 10000,
                          "usageSeconds": 7000
                        },
                        "voiceLocal": {
                          "allowanceSeconds": 20000,
                          "usageSeconds": 15000
                        },
                        "smsInternational": {
                          "allowanceMessages": 5000,
                          "usageMessages": 3500
                        },
                        "smsLocal": {
                          "allowanceMessages": 10000,
                          "usageMessages": 7000
                        },
                        "sms": {
                          "allowanceMessages": 10000,
                          "usageMessages": 7000
                        },
                        "subscriptionAddons": [
                          "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                        ],
                        "voice": {
                          "allowanceSeconds": 50000,
                          "usageSeconds": 35000
                        }
                      },
                      "throttled": {
                        "thresholdBytes": 10000000000,
                        "bandwidthBitsPerSecond": 512000,
                        "until": "2021-02-20T19:38:34Z"
                      },
                      "type": "throttled"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.usageNotification.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "usageNotification",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "type": "throttled"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.usageNotification.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.usageThreshold.exceeded": {
      "post": {
        "tags": [
          "Usage"
        ],
        "operationId": "com.gigs.usageThreshold.exceeded",
        "summary": "com.gigs.usageThreshold.exceeded",
        "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This event is deprecated and will be removed in the future.\n> Please use `com.gigs.usageNotification.created` instead. That event fires\n> with type `thresholdExceeded` at the same time as this one.\n\n\nFires whenever a data, sms or voice usage threshold is exceeded. The\ncurrently-supported thresholds are 70%, 90% and 100%.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.usageThreshold.exceeded"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "usageThresholdExceeded",
                      "allowance": 10000000000,
                      "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "project": "test",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "subscriptionAddons": [
                        "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                      ],
                      "thresholdPercentage": 75,
                      "type": "data",
                      "unit": "bytes",
                      "usage": 7500000000,
                      "usageAt": "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.usageThreshold.exceeded",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "usageThresholdExceeded",
                      "allowance": 10000000000,
                      "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
                      "project": "test",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "subscriptionAddons": [
                        "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                      ],
                      "thresholdPercentage": 75,
                      "type": "data",
                      "unit": "bytes",
                      "usage": 7500000000,
                      "usageAt": "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.usageThreshold.exceeded",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "deprecated": true,
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.user.address.created": {
      "post": {
        "tags": [
          "User Addresses"
        ],
        "operationId": "com.gigs.user.address.created",
        "summary": "com.gigs.user.address.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.user.address.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "userAddress",
                      "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "city": "New York City",
                      "country": "US",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.address.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "userAddress",
                      "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "city": "New York City",
                      "country": "US",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.address.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.user.address.deleted": {
      "post": {
        "tags": [
          "User Addresses"
        ],
        "operationId": "com.gigs.user.address.deleted",
        "summary": "com.gigs.user.address.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.user.address.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "userAddress",
                      "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "city": "New York City",
                      "country": "US",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.address.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "userAddress",
                      "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
                      "city": "New York City",
                      "country": "US",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "line1": "129 West 81st Street",
                      "line2": "Apartment 5",
                      "postalCode": "10024",
                      "state": "NY",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.address.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.user.blocked": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "com.gigs.user.blocked",
        "summary": "com.gigs.user.blocked",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.user.blocked"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.blocked",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.blocked",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.user.created": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "com.gigs.user.created",
        "summary": "com.gigs.user.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.user.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.user.deleted": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "com.gigs.user.deleted",
        "summary": "com.gigs.user.deleted",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.user.deleted"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.deleted",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.deleted",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.user.updated": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "com.gigs.user.updated",
        "summary": "com.gigs.user.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.user.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.user.verified": {
      "post": {
        "tags": [
          "Users"
        ],
        "operationId": "com.gigs.user.verified",
        "summary": "com.gigs.user.verified",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.user.verified"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.verified",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "user",
                      "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "metadata": {},
                      "birthday": "2017-07-21",
                      "createdAt": "2021-01-21T19:38:34Z",
                      "email": "jerry@example.com",
                      "emailVerified": true,
                      "fullName": "Jerry Seinfeld",
                      "preferredLocale": "en-US",
                      "status": "active"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.user.verified",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.virtualNumber.activated": {
      "post": {
        "tags": [
          "Virtual Numbers"
        ],
        "operationId": "com.gigs.virtualNumber.activated",
        "summary": "com.gigs.virtualNumber.activated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.virtualNumber.activated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.activated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.activated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.virtualNumber.canceled": {
      "post": {
        "tags": [
          "Virtual Numbers"
        ],
        "operationId": "com.gigs.virtualNumber.canceled",
        "summary": "com.gigs.virtualNumber.canceled",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.virtualNumber.canceled"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.canceled",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.canceled",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.virtualNumber.created": {
      "post": {
        "tags": [
          "Virtual Numbers"
        ],
        "operationId": "com.gigs.virtualNumber.created",
        "summary": "com.gigs.virtualNumber.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.virtualNumber.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.virtualNumber.ended": {
      "post": {
        "tags": [
          "Virtual Numbers"
        ],
        "operationId": "com.gigs.virtualNumber.ended",
        "summary": "com.gigs.virtualNumber.ended",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.virtualNumber.ended"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.ended",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.ended",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.virtualNumber.updated": {
      "post": {
        "tags": [
          "Virtual Numbers"
        ],
        "operationId": "com.gigs.virtualNumber.updated",
        "summary": "com.gigs.virtualNumber.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.virtualNumber.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "virtualNumber",
                      "id": "vnr_0SNlurA049MEWV29mxRtSMDnKtUD",
                      "activatedAt": "2020-01-01T00:00:07Z",
                      "canceledAt": "2020-07-15T00:00:00Z",
                      "createdAt": "2020-01-01T00:00:00Z",
                      "endedAt": "2020-08-01T00:00:00Z",
                      "phoneNumber": "+447700900000",
                      "status": "active",
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.virtualNumber.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.voucher.created": {
      "post": {
        "tags": [
          "Vouchers"
        ],
        "operationId": "com.gigs.voucher.created",
        "summary": "com.gigs.voucher.created",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.voucher.created"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.voucher.created",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.voucher.created",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.voucher.retired": {
      "post": {
        "tags": [
          "Vouchers"
        ],
        "operationId": "com.gigs.voucher.retired",
        "summary": "com.gigs.voucher.retired",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.voucher.retired"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.voucher.retired",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.voucher.retired",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.voucher.updated": {
      "post": {
        "tags": [
          "Vouchers"
        ],
        "operationId": "com.gigs.voucher.updated",
        "summary": "com.gigs.voucher.updated",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.voucher.updated"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    },
                    "datacontenttype": "application/json",
                    "previousData": {},
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.voucher.updated",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "object": "voucher",
                      "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
                      "createdAt": "2021-02-14T19:38:34Z",
                      "name": "Black Friday",
                      "priceDiscount": {
                        "amount": 999,
                        "currency": "USD"
                      },
                      "priceDiscountPercentage": 30.12,
                      "recurrence": {
                        "type": "once",
                        "durationInMonths": null
                      },
                      "redemptions": 2,
                      "retiredReason": null,
                      "status": "available"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.voucher.updated",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "event"
      }
    },
    "com.gigs.reminder.porting.declined": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.reminder.porting.declined",
        "summary": "com.gigs.reminder.porting.declined",
        "description": "Fired when a porting request has been declined and the user needs to correct the provided information and resubmit.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.reminder.porting.declined"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.porting.declined",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.porting.declined",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "reminder"
      }
    },
    "com.gigs.reminder.porting.informationRequired": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.reminder.porting.informationRequired",
        "summary": "com.gigs.reminder.porting.informationRequired",
        "description": "Fired when a porting request requires additional information from the user, or, for a porting with a manual request behavior, is waiting for the user to confirm it before it is requested.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.reminder.porting.informationRequired"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.porting.informationRequired",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.porting.informationRequired",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "reminder"
      }
    },
    "com.gigs.reminder.porting.requested": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.reminder.porting.requested",
        "summary": "com.gigs.reminder.porting.requested",
        "description": "Fired when a porting is in requested state for a prolonged period so the user can check status with porting's donor provider.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.reminder.porting.requested"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.porting.requested",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.porting.requested",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "reminder"
      }
    },
    "com.gigs.reminder.porting.scheduled": {
      "post": {
        "tags": [
          "Portings"
        ],
        "operationId": "com.gigs.reminder.porting.scheduled",
        "summary": "com.gigs.reminder.porting.scheduled",
        "description": "Fired before a scheduled porting takes effect.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.reminder.porting.scheduled"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.porting.scheduled",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.porting.scheduled",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "reminder"
      }
    },
    "com.gigs.reminder.sim.suspended": {
      "post": {
        "tags": [
          "SIMs"
        ],
        "operationId": "com.gigs.reminder.sim.suspended",
        "summary": "com.gigs.reminder.sim.suspended",
        "description": "Fired while a subscription's SIM stays suspended, 7, 14, 21, 28 and 29 days after the network provider confirmed the suspension. The subscription ends 30 days after that confirmation unless the SIM is unsuspended. `conditionTriggeredAt` is when the suspension was confirmed.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.reminder.sim.suspended"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.sim.suspended",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.sim.suspended",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "reminder"
      }
    },
    "com.gigs.reminder.subscription.pending": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.reminder.subscription.pending",
        "summary": "com.gigs.reminder.subscription.pending",
        "description": "Fired when a subscription has remained in the pending status for an extended period (30 days).\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.reminder.subscription.pending"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.subscription.pending",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.subscription.pending",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "reminder"
      }
    },
    "com.gigs.reminder.subscription.simNotInstalled": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.reminder.subscription.simNotInstalled",
        "summary": "com.gigs.reminder.subscription.simNotInstalled",
        "description": "Fired when an eSIM has been assigned but it is not yet installed on the user's device. Only available for providers that support eSIM lifecycle events (p3, p11, p14, p15).\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.reminder.subscription.simNotInstalled"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.subscription.simNotInstalled",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.subscription.simNotInstalled",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "reminder"
      }
    },
    "com.gigs.reminder.subscription.usageMissing": {
      "post": {
        "tags": [
          "Subscriptions"
        ],
        "operationId": "com.gigs.reminder.subscription.usageMissing",
        "summary": "com.gigs.reminder.subscription.usageMissing",
        "description": "Fired when an eSIM is installed but no usage has been detected after activation. Only available for providers that support eSIM lifecycle events (p3, p11, p14, p15).\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.gigs.reminder.subscription.usageMissing"
              },
              "examples": {
                "Example - Full": {
                  "summary": "Example - Full",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
                      "application": "app_0VGkeexD3f7CKhuFX4iUbB",
                      "member": "mbr_0SNlurA020zhzt0CwsIr53",
                      "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.subscription.usageMissing",
                    "version": "2026-01-29.42"
                  }
                },
                "Example - Required": {
                  "summary": "Example - Required",
                  "value": {
                    "object": "event",
                    "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
                    "actor": {
                      "type": "apiKey"
                    },
                    "data": {
                      "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                      "conditionTriggeredAt": "2025-01-21T19:38:34Z",
                      "number": 1,
                      "nextReminderAt": "2025-01-22T19:38:34Z"
                    },
                    "datacontenttype": "application/json",
                    "project": "gigs",
                    "source": "https://api.gigs.com",
                    "specversion": "1.0",
                    "time": "2022-03-16T14:12:42Z",
                    "type": "com.gigs.reminder.subscription.usageMissing",
                    "version": "2026-01-29.42"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Return any 2xx status code to acknowledge receipt.",
            "content": {}
          }
        },
        "security": [],
        "x-eventKind": "reminder"
      }
    }
  },
  "components": {
    "schemas": {
      "actor": {
        "type": "object",
        "title": "Actor",
        "properties": {
          "apiKey": {
            "type": "string",
            "description": "The unique identifier for the API key.",
            "examples": [
              "apk_0SNlurA049MEWV4wRq2ql6SYZxiY"
            ]
          },
          "application": {
            "type": "string",
            "description": "The unique identifier for the application.",
            "examples": [
              "app_0VGkeexD3f7CKhuFX4iUbB"
            ]
          },
          "member": {
            "type": "string",
            "description": "The unique identifier for the member.",
            "examples": [
              "mbr_0SNlurA020zhzt0CwsIr53"
            ]
          },
          "user": {
            "type": "string",
            "description": "The unique identifier for the user.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "apiKey",
              "application",
              "member",
              "user",
              "system"
            ],
            "description": "The type of actor."
          }
        },
        "required": [
          "type"
        ],
        "examples": [
          {
            "type": "user",
            "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
          },
          {
            "type": "apiKey",
            "apiKey": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY"
          },
          {
            "type": "application",
            "application": "app_0VGkeexD3f7CKhuFX4iUbB"
          },
          {
            "type": "member",
            "member": "mbr_0SNlurA020zhzt0CwsIr53"
          },
          {
            "type": "system"
          }
        ]
      },
      "addon": {
        "type": "object",
        "title": "Add-on",
        "description": "Add-ons define features or top-ups that can be used to extend the functionality offered to the end user through their subscription's plan.",
        "properties": {
          "object": {
            "type": "string",
            "const": "addon",
            "description": "Type of object is always `addon`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the add-on.",
            "examples": [
              "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/metadata"
          },
          "activationTrigger": {
            "type": "string",
            "enum": [
              "creation",
              "networkLatch",
              "usageStarted"
            ],
            "description": "Indicates when a subscription add-on will take effect.\n\n- `creation`: As soon as it is created. The user does not need to take any further action.\n- `networkLatch`: When the user's data session ends, which can be forced by power cycling the device.\n- `usageStarted`: When the user starts using add-on allowance on their device.\n",
            "examples": [
              "creation"
            ]
          },
          "allowances": {
            "type": "object",
            "title": "Allowances",
            "description": "The allowances included in the add-on.",
            "properties": {
              "dataBytes": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The data allowance in bytes. A value of `null` indicates unlimited data.",
                "examples": [
                  10000000000
                ]
              },
              "voiceSeconds": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The voice call allowance in seconds. A value of `null` indicates unlimited calls.",
                "examples": [
                  30000
                ]
              },
              "smsMessages": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The SMS allowance in messages. A value of `null` indicates unlimited SMS.",
                "examples": [
                  100
                ]
              }
            },
            "required": [
              "dataBytes",
              "voiceSeconds",
              "smsMessages"
            ]
          },
          "coverage": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/coverage"
              },
              {
                "type": "null"
              }
            ],
            "description": "The geographic coverage of the add-on. A value of `null` indicates that coverage is not applicable for this add-on."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the add-on was created .",
            "examples": [
              "2021-01-21T19:12:28Z"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "The description of the add-on.",
            "examples": [
              "Disable international roaming."
            ]
          },
          "limits": {
            "type": [
              "object",
              "null"
            ],
            "description": "Usage limits for a recurring add-on: how much data it gets each period, and when it's throttled. The value is `null` if the add-on has none.",
            "properties": {
              "dataBytes": {
                "type": "integer",
                "description": "The maximum amount of data in bytes each period, including the throttled part.",
                "examples": [
                  13000000000
                ]
              },
              "throttling": {
                "type": "object",
                "description": "The throttling configuration for the add-on.",
                "properties": {
                  "thresholdBytes": {
                    "type": "integer",
                    "description": "The threshold in bytes at which throttling will be applied.",
                    "examples": [
                      3000000000
                    ]
                  },
                  "bandwidthBitsPerSecond": {
                    "type": "integer",
                    "description": "The bandwidth in bits per second that the add-on will be throttled to.",
                    "examples": [
                      256000
                    ]
                  }
                },
                "required": [
                  "thresholdBytes",
                  "bandwidthBitsPerSecond"
                ]
              }
            },
            "required": [
              "dataBytes",
              "throttling"
            ]
          },
          "name": {
            "type": "string",
            "description": "Name for the add-on.",
            "examples": [
              "1GB Data Top-up"
            ]
          },
          "plans": {
            "type": "array",
            "description": "The plans this add-on is compatible with.",
            "items": {
              "type": "string",
              "examples": [
                "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
              ]
            }
          },
          "price": {
            "$ref": "#/components/schemas/price",
            "description": "The price of the add-on."
          },
          "provider": {
            "type": "string",
            "description": "The ID of the network provider supported by this add-on.",
            "examples": [
              "p5"
            ]
          },
          "recurrenceType": {
            "type": "string",
            "enum": [
              "oneTime",
              "recurring"
            ],
            "description": "The recurrence type the add-on.",
            "examples": [
              "oneTime"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "available",
              "archived"
            ],
            "description": "The current status of the add-on."
          },
          "type": {
            "type": "string",
            "enum": [
              "topUp",
              "other"
            ],
            "description": "The type of the add-on.",
            "examples": [
              "topUp"
            ]
          },
          "validity": {
            "type": [
              "object",
              "null"
            ],
            "description": "The validity period of the add-on. When the add-on is activated, it will expire after this\n        duration. Not all add-ons have a validity period.",
            "properties": {
              "unit": {
                "type": "string",
                "enum": [
                  "day",
                  "month"
                ],
                "description": "The time unit of the add-on, either `day` or `month`."
              },
              "value": {
                "type": "integer",
                "description": "The amount of units (specified in the `unit` property).",
                "minimum": 1,
                "examples": [
                  7
                ]
              },
              "totalPeriods": {
                "type": "integer",
                "default": 1,
                "description": "How many times the validity period repeats. It is `2` or more for recurring add-ons and `1` for one-time add-ons. The total lifetime (`value` times `unit` times `totalPeriods`) must not exceed 10 years.",
                "maximum": 3652,
                "minimum": 1,
                "examples": [
                  1
                ]
              }
            },
            "required": [
              "unit",
              "value"
            ]
          },
          "data": {
            "type": "integer",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe data allowance in bytes included in this add-on. A value of `-1` indicates unlimited data.",
            "examples": [
              10000000000
            ],
            "deprecated": true
          },
          "dataUnit": {
            "type": "string",
            "const": "byte",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe unit of the data value is always `byte`.",
            "deprecated": true
          },
          "sms": {
            "type": "integer",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe sms allowance included in this add-on. A value of `-1` indicates unlimited sms.",
            "examples": [
              100
            ],
            "deprecated": true
          },
          "smsUnit": {
            "type": "string",
            "const": "message",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe unit of the sms value is always `sms`.",
            "deprecated": true
          },
          "voice": {
            "type": "integer",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe voice call allowance in seconds included in this add-on. A value of `-1` indicates unlimited voice calls.",
            "examples": [
              30000
            ],
            "deprecated": true
          },
          "voiceUnit": {
            "type": "string",
            "const": "second",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe unit of the voice value is always `second`.",
            "deprecated": true
          }
        },
        "required": [
          "object",
          "id",
          "metadata",
          "activationTrigger",
          "allowances",
          "coverage",
          "data",
          "dataUnit",
          "description",
          "limits",
          "name",
          "plans",
          "price",
          "provider",
          "recurrenceType",
          "sms",
          "smsUnit",
          "status",
          "type",
          "validity",
          "voice",
          "voiceUnit",
          "createdAt"
        ]
      },
      "allowance": {
        "type": "object",
        "title": "Allowance",
        "description": "An allowance represents a specific usage limit (e.g., minutes, bytes, messages) the purchase of a product entitles a user to.",
        "properties": {
          "object": {
            "type": "string",
            "const": "allowance",
            "description": "Type of object is always `allowance`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the allowance.",
            "examples": [
              "alw_0SNlurA049MEWV3OMTRrGKbd99GH"
            ]
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of this allowance.",
            "examples": [
              "Roaming data in Europe"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "data",
              "voice",
              "sms"
            ],
            "description": "The type of usage permitted by this allowance."
          },
          "coverage": {
            "$ref": "#/components/schemas/coverage",
            "description": "The geographic coverage of the allowance."
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The amount of usage permitted by this allowance counted in `unit`. A value of `null` indicates an unlimited allowance.",
            "examples": [
              500
            ]
          },
          "unit": {
            "type": "string",
            "enum": [
              "bytes",
              "seconds",
              "messages"
            ],
            "description": "The unit the usage permitted by this allowance is counted in."
          }
        },
        "required": [
          "object",
          "id",
          "name",
          "type",
          "coverage",
          "limit",
          "unit"
        ]
      },
      "apiKey": {
        "type": "object",
        "title": "APIKey",
        "properties": {
          "object": {
            "type": "string",
            "const": "apiKey",
            "description": "Type of object is always `apiKey`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the API key.",
            "examples": [
              "apk_0SNlurA049MEWV4wRq2ql6SYZxiY"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the API key was created.",
            "examples": [
              "2022-02-14T19:38:34Z"
            ]
          },
          "expiresAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the API key expires and won't be valid anymore.",
            "examples": [
              "2022-02-21T19:38:34Z"
            ]
          },
          "name": {
            "type": "string",
            "description": "Human readable name describing what the API key is used for.",
            "examples": [
              "My first Gigs API integration"
            ]
          },
          "token": {
            "type": "string",
            "description": "The bearer token to be used in HTTP Authorization. The full token is only available in the create response. In all other responses a redacted token will be returned, as we do not store the full token ourselves.",
            "examples": [
              "gpk_2W4IoEFH••••"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "name",
          "token",
          "createdAt",
          "expiresAt"
        ]
      },
      "consentRequest": {
        "type": "object",
        "title": "ConsentRequest",
        "properties": {
          "object": {
            "type": "string",
            "const": "consentRequest",
            "description": "Type of object is always `consentRequest`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the consent request.",
            "examples": [
              "crq_0SNlurA049MEWV2jN9EvAfKMf7VU"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp at which the consent request was created.",
            "examples": [
              "2024-01-09T15:00:51Z"
            ]
          },
          "deliveryMethod": {
            "type": [
              "null",
              "string"
            ],
            "enum": [
              null,
              "emailLink",
              "sms",
              "smsLink",
              "smsOTP"
            ],
            "description": "The method by which the consent request is delivered to the user.",
            "examples": [
              "emailLink"
            ]
          },
          "expiredAt": {
            "type": [
              "null",
              "string"
            ],
            "format": "date-time",
            "description": "The timestamp at which the consent request expired.",
            "examples": [
              "2024-01-09T15:00:51Z"
            ]
          },
          "operation": {
            "type": "string",
            "enum": [
              "change.phoneNumber",
              "change.provider",
              "exchange.sim",
              "issue.portOutCredentials",
              "portin.subscription"
            ],
            "description": "The operation being requested.",
            "examples": [
              "exchange.sim"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "approved",
              "bypassed",
              "canceled",
              "expired",
              "pending"
            ],
            "description": "The status of the consent request.",
            "examples": [
              "pending"
            ]
          },
          "subject": {
            "type": "string",
            "description": "The ID of resource being affected by the operation. It can be for example a port out ID, if the operation is `issue.portOutCredentials`.",
            "examples": [
              "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
            ]
          },
          "subscription": {
            "type": "string",
            "description": "Unique identifier for the subscription inferred from the resource associated with this consent request, e.g. a port-out, porting, or subscription change.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "deliveryMethod",
          "operation",
          "status",
          "subject",
          "subscription",
          "createdAt",
          "expiredAt"
        ]
      },
      "coverage": {
        "type": "object",
        "title": "Coverage",
        "properties": {
          "object": {
            "type": "string",
            "const": "coverage",
            "description": "Type of object is always `coverage`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the coverage configuration.",
            "examples": [
              "de"
            ]
          },
          "countries": {
            "type": "array",
            "description": "List of countries in ISO 3166-1 alpha-2 format covered by this coverage configuration.",
            "items": {
              "type": "string",
              "format": "ISO 3166-1 alpha-2",
              "examples": [
                "DE"
              ]
            },
            "examples": [
              [
                "DE",
                "FR",
                "US"
              ]
            ]
          },
          "name": {
            "type": "string",
            "description": "A human-readable identifier of the coverage configuration, might not be unique.",
            "examples": [
              "Europe"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "countries",
          "name"
        ]
      },
      "device": {
        "type": "object",
        "title": "Device",
        "description": "Devices are the phones or smartwatches that will be tied to a user’s plan.",
        "properties": {
          "object": {
            "type": "string",
            "const": "device",
            "description": "Type of object is always `device`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the device.",
            "examples": [
              "dev_0SNlurA049MEWV55CrA9qMvI2FVJ"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/metadata"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the device was created.",
            "examples": [
              "2021-02-14T19:38:34Z"
            ]
          },
          "imei": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^[0-9]{15,16}$",
            "description": "The IMEI (international mobile equipment identity) of the device if provided.",
            "examples": [
              "492388841798923"
            ]
          },
          "model": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/deviceModel"
              },
              {
                "type": "null"
              }
            ]
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "description": "An optional custom name for the device.",
            "examples": [
              "Anna's iPhone 12 Pro"
            ]
          },
          "sims": {
            "type": "array",
            "description": "List of SIMs added to this device.",
            "items": {
              "$ref": "#/components/schemas/sim"
            }
          },
          "user": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/user"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "object",
          "id",
          "metadata",
          "imei",
          "model",
          "name",
          "sims",
          "user",
          "createdAt"
        ]
      },
      "deviceModel": {
        "type": "object",
        "title": "DeviceModel",
        "properties": {
          "object": {
            "type": "string",
            "const": "deviceModel",
            "description": "Type of object is always `deviceModel`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the deviceModel.",
            "examples": [
              "dmd_0SNlurA04OUskUGfGAn3Rh"
            ]
          },
          "brand": {
            "type": "string",
            "description": "The brand of the device model.",
            "examples": [
              "Apple"
            ]
          },
          "hardwareIdentifiers": {
            "type": "array",
            "description": "List of hardware identifiers (e.g. the Android `Build.MODEL` string) associated with this device model.",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "SM-S928U1"
              ]
            ]
          },
          "name": {
            "type": "string",
            "description": "The device model's name.",
            "examples": [
              "iPhone 12 Pro"
            ]
          },
          "simTypes": {
            "type": "array",
            "description": "List of SIM types supported by this device model.",
            "items": {
              "type": "string",
              "enum": [
                "eSIM",
                "pSIM"
              ]
            },
            "examples": [
              [
                "eSIM",
                "pSIM"
              ]
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "car",
              "iot",
              "laptop",
              "router",
              "smartphone",
              "feature-phone",
              "smartwatch",
              "tablet",
              "wearable",
              "other"
            ],
            "description": "The type of the device model.",
            "examples": [
              "smartphone"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "brand",
          "name",
          "simTypes",
          "type",
          "hardwareIdentifiers"
        ]
      },
      "deviceModelBrands": {
        "type": "object",
        "title": "DeviceModelBrands",
        "properties": {
          "object": {
            "type": "string",
            "const": "deviceModelBrands",
            "description": "List of device model brands."
          },
          "items": {
            "type": "array",
            "description": "A list of brands.",
            "items": {
              "type": "string",
              "examples": [
                "Apple"
              ]
            }
          }
        },
        "required": [
          "object",
          "items"
        ]
      },
      "error": {
        "type": "object",
        "title": "Error",
        "properties": {
          "object": {
            "type": "string",
            "const": "error",
            "description": "Type of object is always `error`."
          },
          "code": {
            "type": "string",
            "description": "An optional machine-readable description of the error. Present for errors that could be handled programmatically.",
            "examples": [
              "unknown"
            ]
          },
          "details": {
            "type": "array",
            "description": "Optional array containing specific information for the current error.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "items": {
              "$ref": "#/components/schemas/propertyErrorDetailError"
            }
          },
          "documentation": {
            "type": "array",
            "description": "An optional list of URLs providing further information to resolve the error.",
            "items": {
              "type": "string",
              "examples": [
                "https://developers.gigs.com/api/error-handling"
              ]
            }
          },
          "hint": {
            "type": "string",
            "description": "An optional explanation how to resolve the error.",
            "examples": [
              "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i"
            ]
          },
          "message": {
            "type": "string",
            "description": "A human readable description of the error.",
            "examples": [
              "Invalid ICCID format."
            ]
          },
          "type": {
            "type": "string",
            "description": "The type of [error](https://developers.gigs.com/api/error-handling) returned.",
            "examples": [
              "invalid"
            ]
          }
        },
        "required": [
          "object",
          "message",
          "type"
        ]
      },
      "eSimProfile": {
        "type": "object",
        "title": "EsimProfile",
        "properties": {
          "object": {
            "type": "string",
            "const": "eSimProfile",
            "description": "Type of object is always `eSimProfile`."
          },
          "sim": {
            "$ref": "#/components/schemas/sim"
          },
          "status": {
            "type": "string",
            "enum": [
              "deleted",
              "disabled",
              "downloaded",
              "enabled",
              "installed",
              "unknown"
            ],
            "description": "The current status of the eSimProfile.\n\nSupported providers are `p3`, `p11`, `p12`, `p14`, `p15`, `p18` and `p32`.\n\nThis will be `unknown` when:\n  - the SIM's provider is not supported; or\n  - no lifecycle status has been received for the given SIM.\n\nRelated guide: [eSIM profile lifecycle](https://developers.gigs.com/docs/core/sims#e-sim-profile-lifecycle)\n"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time at which the eSIM profile was last updated.",
            "examples": [
              "2024-03-13T15:36:01Z"
            ]
          }
        },
        "required": [
          "object",
          "sim",
          "status",
          "updatedAt"
        ]
      },
      "metadata": {
        "type": "object",
        "title": "Metadata",
        "description": "A set of key-value pairs, to store [metadata](https://developers.gigs.com/docs/core/metadata) related to the resource.",
        "additionalProperties": {
          "type": "string",
          "maxLength": 255
        }
      },
      "metadataUpdate": {
        "type": "object",
        "title": "Metadata",
        "description": "A set of key-value pairs, to store [metadata](https://developers.gigs.com/docs/core/metadata) related to the resource.",
        "additionalProperties": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 255
        }
      },
      "networkAvailability": {
        "type": "object",
        "title": "NetworkAvailability",
        "description": "<!-- theme: info -->\n> #### Preview\n>\n> This schema is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "networkAvailability",
            "description": "Type of object is always `networkAvailability`."
          },
          "availability": {
            "type": "array",
            "description": "A list of availability details for the plans in the project.",
            "items": {
              "type": "object",
              "properties": {
                "plan": {
                  "type": "string",
                  "description": "The unique identifier for the plan.",
                  "examples": [
                    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                  ]
                },
                "provider": {
                  "type": "string",
                  "description": "The ID of the network provider supported by this plan.",
                  "examples": [
                    "p11"
                  ]
                },
                "technologies": {
                  "type": "object",
                  "description": "The technologies supported by the network provider.",
                  "examples": [
                    {
                      "4G": {
                        "strength": "good",
                        "minDecibelMilliwatts": -90
                      },
                      "5G": {
                        "strength": "fair",
                        "minDecibelMilliwatts": -100
                      }
                    }
                  ],
                  "additionalProperties": {
                    "type": "object",
                    "title": "NetworkAvailabilityDataPoint",
                    "properties": {
                      "strength": {
                        "type": "string",
                        "enum": [
                          "poor",
                          "fair",
                          "good",
                          "excellent",
                          "unknown"
                        ],
                        "description": "A qualitative description of the signal's strength.",
                        "examples": [
                          "excellent"
                        ]
                      },
                      "minDecibelMilliwatts": {
                        "type": "number",
                        "description": "The minimum signal strength recorded in dBm.",
                        "examples": [
                          -100
                        ]
                      }
                    },
                    "required": [
                      "strength",
                      "minDecibelMilliwatts"
                    ]
                  }
                }
              },
              "required": [
                "plan",
                "provider",
                "technologies"
              ]
            }
          },
          "location": {
            "type": "object",
            "description": "The location for which availability information is provided.",
            "properties": {
              "address": {
                "type": "object",
                "title": "NetworkAvailabilityAddress",
                "description": "The address for which availability information is provided.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This schema is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                "properties": {
                  "city": {
                    "type": "string",
                    "description": "The city/municipality of the address.",
                    "examples": [
                      "New York City"
                    ]
                  },
                  "country": {
                    "type": "string",
                    "description": "The ISO 3166-1 alpha-2 country code of the address.",
                    "examples": [
                      "US"
                    ]
                  },
                  "line1": {
                    "type": "string",
                    "description": "The first line of the address, e.g. street and house number.",
                    "examples": [
                      "129 West 81st Street"
                    ]
                  },
                  "line2": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The second line of the address, e.g. apartment number.",
                    "examples": [
                      "Apartment 5"
                    ]
                  },
                  "postalCode": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The postal code of the address.",
                    "examples": [
                      "10024"
                    ]
                  },
                  "state": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The state/province/region of the address.",
                    "examples": [
                      "NY"
                    ]
                  }
                },
                "required": [
                  "city",
                  "country",
                  "line1"
                ]
              },
              "coordinates": {
                "type": "object",
                "title": "NetworkAvailabilityCoordinates",
                "description": "The coordinates for which availability information is provided.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This schema is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                "properties": {
                  "latitude": {
                    "type": "number",
                    "description": "The latitude coordinate for which availability information is provided.",
                    "maximum": 90,
                    "minimum": -90,
                    "examples": [
                      40.7831
                    ]
                  },
                  "longitude": {
                    "type": "number",
                    "description": "The longitude coordinate for which availability information is provided.",
                    "maximum": 180,
                    "minimum": -180,
                    "examples": [
                      -73.9712
                    ]
                  }
                },
                "required": [
                  "latitude",
                  "longitude"
                ]
              }
            }
          }
        },
        "required": [
          "object",
          "availability",
          "location"
        ]
      },
      "networkAvailabilityTileset": {
        "type": "object",
        "title": "NetworkAvailabilityTileset",
        "description": "<!-- theme: info -->\n> #### Preview\n>\n> This schema is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "networkAvailabilityTileset",
            "description": "Type of object is always `networkAvailabilityTileset`."
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the signed `urlTemplate` expires. Fetch the tilesets again before then.",
            "examples": [
              "2026-08-04T12:00:00Z"
            ]
          },
          "layers": {
            "type": "array",
            "description": "The layers inside the tiles, ordered from the broadest coverage to the fastest technology.",
            "items": {
              "type": "object",
              "properties": {
                "technology": {
                  "type": "string",
                  "description": "The network technology the layer covers.",
                  "examples": [
                    "5G"
                  ]
                },
                "sourceLayer": {
                  "type": "string",
                  "description": "The layer's name inside a tile. Use it as the source layer in a map library.",
                  "examples": [
                    "coverage_5g"
                  ]
                }
              },
              "required": [
                "technology",
                "sourceLayer"
              ]
            }
          },
          "maxZoom": {
            "type": "integer",
            "description": "The highest zoom level the tiles cover. Beyond it, map libraries scale up existing tiles instead of fetching new ones.",
            "examples": [
              10
            ]
          },
          "minZoom": {
            "type": "integer",
            "description": "The lowest zoom level the tiles cover.",
            "examples": [
              0
            ]
          },
          "urlTemplate": {
            "type": "string",
            "description": "Tile URL template in the standard XYZ format. Pass it to a map library unchanged: the library fills in the `{z}`, `{x}` and `{y}` placeholders.",
            "examples": [
              "https://tiles.gigs.com/tiles/default/2026-08-03/{z}/{x}/{y}.pbf?URLPrefix=aHR0cHM6Ly90aWxlcy5naWdzLmNvbS90aWxlcy9kZWZhdWx0LzIwMjYtMDgtMDMv&Expires=1785844800&KeyName=tiles-key-20260930&Signature=pciE55nCNX-qhXzJNSAXaf34624="
            ]
          }
        },
        "required": [
          "object",
          "expiresAt",
          "layers",
          "maxZoom",
          "minZoom",
          "urlTemplate"
        ]
      },
      "organization": {
        "type": "object",
        "title": "Organization",
        "properties": {
          "object": {
            "type": "string",
            "const": "organization",
            "description": "Type of object is always `organization`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the organization.",
            "examples": [
              "org_0SNlurA04kOdemVEMVZQBF"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the organization was created.",
            "examples": [
              "2021-02-01T13:21:30Z"
            ]
          },
          "name": {
            "type": "string",
            "description": "Name for the organization.",
            "examples": [
              "Gigs"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "name",
          "createdAt"
        ]
      },
      "period": {
        "type": "object",
        "title": "Period",
        "properties": {
          "number": {
            "type": "integer",
            "description": "Sequence number of the period.",
            "minimum": 1,
            "examples": [
              1
            ]
          },
          "start": {
            "type": "string",
            "format": "date-time",
            "description": "Beginning of the period.",
            "examples": [
              "2021-01-21T19:32:13Z"
            ]
          },
          "end": {
            "type": "string",
            "format": "date-time",
            "description": "End of the period.",
            "examples": [
              "2021-02-20T19:38:34Z"
            ]
          }
        },
        "required": [
          "number",
          "start",
          "end"
        ]
      },
      "plan": {
        "type": "object",
        "title": "Plan",
        "description": "Plans define the network options and parameters offered to the end user, e.g. 'Unlimited data, voice & text'. Plan allowances (data, sms, voice) and limits are configurable, and Gigs will work with you to find the best balance for your users.",
        "properties": {
          "object": {
            "type": "string",
            "const": "plan",
            "description": "Type of object is always `plan`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the plan.",
            "examples": [
              "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/metadata"
          },
          "activationTrigger": {
            "type": "string",
            "enum": [
              "creation",
              "usageStarted"
            ],
            "description": "Indicates when a subscription will activate.\n\n- `creation`: As soon as it is created. The user does not need to take any further action.\n- `usageStarted`: When the user starts using subscription allowance on their device.\n",
            "examples": [
              "creation"
            ]
          },
          "allowances": {
            "type": "object",
            "title": "Allowances",
            "description": "Usage allowances included in the plan - i.e. how many bytes of data, voice minutes & sms messages the user has access to.",
            "properties": {
              "dataBytes": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The data allowance in bytes. A value of `null` indicates unlimited data.",
                "examples": [
                  10000000000
                ]
              },
              "voiceSeconds": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The voice call allowance in seconds. A value of `null` indicates unlimited calls.",
                "examples": [
                  30000
                ]
              },
              "smsMessages": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The SMS allowance in messages. A value of `null` indicates unlimited SMS.",
                "examples": [
                  100
                ]
              }
            },
            "required": [
              "dataBytes",
              "voiceSeconds",
              "smsMessages"
            ]
          },
          "coverage": {
            "$ref": "#/components/schemas/coverage",
            "description": "The geographic coverage of the plan."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the plan was created.",
            "examples": [
              "2021-01-21T19:38:34Z"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "The plan's description, meant to be displayable to the users.",
            "examples": [
              "A data plan you will love! Operates in most countries of the world."
            ]
          },
          "firstPeriodTrigger": {
            "type": "string",
            "enum": [
              "activation",
              "creation"
            ],
            "description": "Indicates when a subscription's first period will start.\n\n- `creation`: As soon as the subscription is created.\n- `activation`: When the subscription's status transitions from `pending` to `active`.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              "creation"
            ]
          },
          "image": {
            "type": [
              "string",
              "null"
            ],
            "format": "url",
            "description": "The plan's image, meant to be displayable to the users.",
            "examples": [
              "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png"
            ]
          },
          "limits": {
            "type": "object",
            "title": "Limits",
            "description": "Usage limits for the plan - i.e. the maximum available bandwidth, fair-use data limits and throttling threshold.",
            "properties": {
              "dataBytes": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The maximum amount of data that can be used in bytes. A value of `null` indicates unlimited data.",
                "examples": [
                  100000000000
                ]
              },
              "bandwidthBitsPerSecond": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The maximum bandwidth in bits per second. A value of `null` indicates the maximum bandwidth this network allows.",
                "examples": [
                  100000000
                ]
              },
              "throttling": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "The throttling configuration for the plan, if any.",
                "properties": {
                  "thresholdBytes": {
                    "type": "integer",
                    "description": "The threshold in bytes at which throttling will be applied.",
                    "examples": [
                      10000000000
                    ]
                  },
                  "bandwidthBitsPerSecond": {
                    "type": "integer",
                    "description": "The bandwidth in bits per second that the plan will be throttled to.",
                    "examples": [
                      512000
                    ]
                  }
                },
                "required": [
                  "thresholdBytes",
                  "bandwidthBitsPerSecond"
                ]
              }
            },
            "required": [
              "dataBytes",
              "bandwidthBitsPerSecond",
              "throttling"
            ]
          },
          "name": {
            "type": "string",
            "description": "The plan's name, meant to be displayable to the users.",
            "examples": [
              "Gigs Global"
            ]
          },
          "price": {
            "$ref": "#/components/schemas/price",
            "description": "The price of the plan."
          },
          "provider": {
            "type": "string",
            "description": "The ID of the network provider supported by this plan.",
            "examples": [
              "p5"
            ]
          },
          "requirements": {
            "type": "object",
            "description": "Required information that must be collected from the user in order to create a subscription with this plan.",
            "properties": {
              "address": {
                "type": "string",
                "enum": [
                  "none",
                  "present",
                  "verified"
                ],
                "description": "The address requirements that must be fulfilled before a user may purchase a subscription.",
                "examples": [
                  "present"
                ]
              },
              "device": {
                "type": "string",
                "enum": [
                  "none",
                  "present",
                  "verified"
                ],
                "description": "The device requirements that must be fulfilled before a user may purchase a subscription."
              },
              "user.birthday": {
                "type": "string",
                "enum": [
                  "none",
                  "present",
                  "verified"
                ],
                "description": "The user birthday requirements that must be fulfilled before a user may purchase a subscription."
              },
              "user.fullName": {
                "type": "string",
                "enum": [
                  "none",
                  "present",
                  "verified"
                ],
                "description": "The user full name requirements that must be fulfilled before a user may purchase a subscription.",
                "examples": [
                  "present"
                ]
              }
            },
            "required": [
              "address",
              "device",
              "user.birthday",
              "user.fullName"
            ]
          },
          "simTypes": {
            "type": "array",
            "description": "List of SIM types supported by this plan. Can be `eSIM`, `pSIM`, or both.",
            "items": {
              "type": "string",
              "enum": [
                "eSIM",
                "pSIM"
              ]
            },
            "examples": [
              [
                "eSIM",
                "pSIM"
              ]
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "available",
              "archived",
              "pending",
              "draft"
            ]
          },
          "validity": {
            "type": "object",
            "title": "Validity",
            "description": "Plan validity information - i.e. subscription period length, and the minimum number of periods before the plan can be ended.",
            "properties": {
              "minimumPeriods": {
                "type": "integer",
                "description": "The minimum number of subscription periods that the plan must be renewed.",
                "minimum": 0,
                "examples": [
                  12
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "recurring",
                  "oneTime"
                ],
                "description": "The validity type of this plan."
              },
              "unit": {
                "type": "string",
                "enum": [
                  "day",
                  "month"
                ],
                "description": "The time unit of the subscription period."
              },
              "value": {
                "type": "integer",
                "description": "The amount of units (specified in the `unit` property) in each subscription period. The total validity duration (`value` times `unit`) must not exceed 10 years.",
                "minimum": 1,
                "examples": [
                  7
                ]
              }
            },
            "required": [
              "minimumPeriods",
              "type",
              "unit",
              "value"
            ]
          },
          "data": {
            "type": "integer",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe data allowance in bytes included in this plan. A value of `-1` indicates unlimited data.",
            "examples": [
              10000000000
            ],
            "deprecated": true
          },
          "dataUnit": {
            "type": "string",
            "const": "byte",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe unit of the data value is always `byte`.",
            "deprecated": true
          },
          "sms": {
            "type": "integer",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe sms allowance included in this plan. A value of `-1` indicates unlimited sms.",
            "examples": [
              100
            ],
            "deprecated": true
          },
          "smsUnit": {
            "type": "string",
            "const": "message",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe unit of the sms value is always `message`.",
            "deprecated": true
          },
          "voice": {
            "type": "integer",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe voice allowance included in this plan. A value of `-1` indicates unlimited voice.",
            "examples": [
              30000
            ],
            "deprecated": true
          },
          "voiceUnit": {
            "type": "string",
            "const": "second",
            "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `allowances` instead.\n\n\nThe unit of the voice value is always `second`.",
            "deprecated": true
          }
        },
        "required": [
          "object",
          "id",
          "metadata",
          "activationTrigger",
          "allowances",
          "coverage",
          "data",
          "dataUnit",
          "description",
          "firstPeriodTrigger",
          "image",
          "limits",
          "name",
          "price",
          "provider",
          "requirements",
          "simTypes",
          "sms",
          "smsUnit",
          "status",
          "validity",
          "voice",
          "voiceUnit",
          "createdAt"
        ]
      },
      "planDocument": {
        "type": "object",
        "title": "PlanDocument",
        "properties": {
          "object": {
            "type": "string",
            "const": "planDocument",
            "description": "Type of object is always `planDocument`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the given document.",
            "examples": [
              "pdc_0SNlurA049MEWV1S6e1qVqBV2xge"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The time the document was created.",
            "examples": [
              "2022-07-04T16:20:27.59Z"
            ]
          },
          "language": {
            "type": [
              "null",
              "string"
            ],
            "description": "The language of the document. The values follow the BCP 47 standard. That means, for instance, that a region can be specified in addition to the language.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              "en-US"
            ]
          },
          "name": {
            "type": "string",
            "description": "The name of the document.",
            "examples": [
              "My Plan Contract"
            ]
          },
          "plan": {
            "type": "string",
            "description": "Unique identifier for the plan associated to this document.",
            "examples": [
              "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
            ]
          },
          "type": {
            "type": "string",
            "description": "The MIME type for the given document.",
            "examples": [
              "application/pdf"
            ]
          },
          "url": {
            "type": "string",
            "description": "The URL at which the document can be retrieved.",
            "examples": [
              "https://a.gigscdn.net/p/my-project/01G74ZPB5PQTDESM4JGYR2CWB9.pdf"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "language",
          "name",
          "plan",
          "type",
          "url",
          "createdAt"
        ]
      },
      "porting": {
        "type": "object",
        "title": "Porting",
        "description": "Porting is required when a user wants to keep their phone number when changing their subscription. There are multiple steps involved between the user, their previous carrier, and the new subscriber",
        "properties": {
          "object": {
            "type": "string",
            "const": "porting",
            "description": "Type of object is always `porting`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the porting.",
            "examples": [
              "prt_0SNlurA049MEWV39s2kSYqaat7ZS"
            ]
          },
          "accountNumber": {
            "type": [
              "string",
              "null"
            ],
            "description": "The account number on the donor service provider.",
            "examples": [
              "123456789"
            ]
          },
          "accountPinExists": {
            "type": "boolean",
            "description": "Whether the account PIN has been provided.",
            "examples": [
              true
            ]
          },
          "accountType": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              null,
              "postpaidMulti",
              "postpaidSingle",
              "prepaidRegistered",
              "prepaidUnregistered"
            ],
            "description": "The type of account on the donor service provider. This field is only used for portings in Ireland and may be `null` otherwise.",
            "examples": [
              "prepaidUnregistered"
            ]
          },
          "address": {
            "type": [
              "object",
              "null"
            ],
            "description": "The address of the account holder on the donor service provider.",
            "properties": {
              "city": {
                "type": "string",
                "description": "The city/municipality of the address.",
                "examples": [
                  "New York City"
                ]
              },
              "country": {
                "type": "string",
                "description": "The ISO 3166-1 alpha-2 country code of the address.",
                "examples": [
                  "US"
                ]
              },
              "line1": {
                "type": "string",
                "description": "The first line of the address, e.g. street and house number.",
                "examples": [
                  "129 West 81st Street"
                ]
              },
              "line2": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "TThe second line of the address, e.g. apartment number.",
                "examples": [
                  "Apartment 5"
                ]
              },
              "postalCode": {
                "type": "string",
                "description": "The postal code of the address.",
                "examples": [
                  "10024"
                ]
              },
              "state": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The state/province/region of the address.",
                "examples": [
                  "NY"
                ]
              }
            },
            "required": [
              "city",
              "country",
              "line1",
              "line2",
              "postalCode",
              "state"
            ]
          },
          "behavior": {
            "type": "string",
            "enum": [
              "cancelOnly",
              "portIn"
            ],
            "description": "The behavior of the porting.\n\nA value of `portIn` indicates that this porting\nwill transfer the phone number from the previous provider.\n\nA porting with behavior `cancelOnly` will cancel\nthe previous service without transferring the number. This behavior is\ncurrently only available for local plans in the United Kingdom.\n",
            "examples": [
              "portIn"
            ]
          },
          "billingPinExists": {
            "type": "boolean",
            "description": "Whether the billing PIN has been provided.",
            "examples": [
              true
            ]
          },
          "birthday": {
            "type": [
              "string",
              "null"
            ],
            "format": "date",
            "description": "The birthday of the account holder on the donor service provider.",
            "examples": [
              "2017-07-21"
            ]
          },
          "canceledAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the porting was canceled.",
            "examples": [
              "2021-01-21T19:39:53Z"
            ]
          },
          "completedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the porting was completed.",
            "examples": [
              "2021-01-21T19:36:57Z"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the porting was created.",
            "examples": [
              "2021-01-21T19:12:28Z"
            ]
          },
          "declinedAttempts": {
            "type": "integer",
            "description": "The number of declined porting attempts so far.",
            "minimum": 0,
            "examples": [
              0
            ]
          },
          "declinedCode": {
            "type": [
              "string",
              "null"
            ],
            "description": "The code reason for the declined porting.",
            "examples": [
              "portingPhoneNumberPortProtected"
            ]
          },
          "declinedMessage": {
            "type": [
              "string",
              "null"
            ],
            "description": "The reason description for the declined porting.",
            "examples": [
              "The phone number has port protection on the provider."
            ]
          },
          "donorProvider": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/serviceProvider"
              },
              {
                "type": "null"
              }
            ],
            "description": "The service provider from whom the number is ported."
          },
          "donorProviderApproval": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Whether the donor provider has approved or not the porting.",
            "examples": [
              true
            ]
          },
          "expiredAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the porting was expired.",
            "examples": [
              "2021-01-21T19:39:53Z"
            ]
          },
          "failedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the porting was failed.",
            "examples": [
              "2021-01-21T19:39:53Z"
            ]
          },
          "failureReason": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              null,
              "consentCodeAttemptsExceeded",
              "consentNotGiven",
              "consentRequestCanceled"
            ],
            "description": "The reason for the porting failure. Only recorded when the porting failed because user consent could not be obtained.",
            "examples": [
              "consentNotGiven"
            ]
          },
          "firstName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The first name of the account holder on the donor service provider.",
            "examples": [
              "Jerry"
            ]
          },
          "lastDeclinedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the porting was last declined.",
            "examples": [
              "2021-01-21T19:31:13Z"
            ]
          },
          "lastName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The last name of the account holder on the donor service provider.",
            "examples": [
              "Seinfeld"
            ]
          },
          "lastRequestedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the porting was last requested.",
            "examples": [
              "2021-01-21T19:22:31Z"
            ]
          },
          "phoneNumber": {
            "type": "string",
            "format": "E.164",
            "description": "The phone number to port in E.164 string_format.",
            "examples": [
              "+19591234567"
            ]
          },
          "provider": {
            "type": "string",
            "description": "The ID of the recipient network provider.",
            "examples": [
              "p9"
            ]
          },
          "recipientProvider": {
            "$ref": "#/components/schemas/serviceProvider",
            "description": "The service provider to whom the number is ported."
          },
          "requestBehavior": {
            "type": "string",
            "enum": [
              "automatic",
              "manual"
            ],
            "description": "Controls when the porting is submitted to the recipient network provider.\n\nWhen `automatic`, the porting is requested automatically as soon as all required information is present.\n\nWhen `manual`, that automatic submission is withheld until the porting is requested explicitly via the [request a porting](https://developers.gigs.com/core/portings#request-a-porting) endpoint. A `manual` porting that has all required information waits in the `informationRequired` status, or in `declined` if it was declined, until it is requested.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              "automatic"
            ]
          },
          "required": {
            "type": "array",
            "description": "List of fields required for the porting to be processable. The fields depend on the donor and recipient providers.",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "accountNumber",
                "accountPin",
                "accountType",
                "address",
                "birthday",
                "donorProvider",
                "donorProviderApproval",
                "firstName",
                "lastName"
              ]
            ]
          },
          "scheduledOn": {
            "type": [
              "string",
              "null"
            ],
            "format": "date",
            "description": "Date when the porting is scheduled to take effect.\n\nFor most providers this returns the provider-confirmed date when available,\notherwise the user-requested date. For Concierge scheduled porting (p18), this\nreturns the user-facing expected completion date and does not reflect the\ninternal batch run date.\n\nScheduling a port-in is only supported in France, Ireland, Sweden and the United Kingdom. For other regions this reflects the provider-confirmed date when available or `null` otherwise.\n",
            "examples": [
              "2021-01-21"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "initiated",
              "pending",
              "informationRequired",
              "requested",
              "declined",
              "completed",
              "canceled",
              "expired",
              "failed"
            ],
            "description": "The current status of the porting."
          },
          "subscription": {
            "type": [
              "string",
              "null"
            ],
            "description": "Unique identifier for the porting subscription.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          },
          "user": {
            "type": "string",
            "description": "Unique identifier for the user this porting is for.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "accountNumber",
          "accountPinExists",
          "accountType",
          "address",
          "behavior",
          "billingPinExists",
          "scheduledOn",
          "birthday",
          "declinedAttempts",
          "declinedCode",
          "declinedMessage",
          "donorProvider",
          "donorProviderApproval",
          "firstName",
          "lastName",
          "phoneNumber",
          "provider",
          "recipientProvider",
          "requestBehavior",
          "required",
          "status",
          "subscription",
          "user",
          "canceledAt",
          "completedAt",
          "createdAt",
          "expiredAt",
          "failedAt",
          "failureReason",
          "lastDeclinedAt",
          "lastRequestedAt"
        ]
      },
      "portOut": {
        "type": "object",
        "title": "PortOut",
        "description": "Port out is required when a user wants to keep their number when cancelling their subscription. There are multiple steps involved between the user, the current carrier, and the new carrier.",
        "properties": {
          "object": {
            "type": "string",
            "const": "portOut",
            "description": "Type of object is always `portOut`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the port out.",
            "examples": [
              "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
            ]
          },
          "behavior": {
            "type": "string",
            "enum": [
              "cancelOnly",
              "portOut"
            ],
            "description": "The behavior of the port out.\n\nA value of `portOut` indicates that using this\nport out will transfer the phone number to the recipient provider.\n\nPort out with behavior `cancelOnly`\nwill cancel the service without transferring the number. This behavior is\ncurrently only available for local plans in the United Kingdom.\n",
            "examples": [
              "portOut"
            ]
          },
          "completedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the port out is completed successfully.",
            "examples": [
              "2022-02-21T19:38:34Z"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the port out was created.",
            "examples": [
              "2020-01-01T00:00:00Z"
            ]
          },
          "expirationRequestedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when early expiration of the port out was requested.",
            "examples": [
              "2022-02-21T19:38:12Z"
            ]
          },
          "expiredAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the port out expires and won't be valid anymore.",
            "examples": [
              "2022-02-21T19:38:34Z"
            ]
          },
          "failureReason": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              null,
              "consentNotGiven",
              "consentRequestCanceled"
            ],
            "description": "The reason for the port out failure.",
            "examples": [
              "consentNotGiven"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "completed",
              "expired",
              "failed",
              "initiated",
              "issued",
              "processing"
            ],
            "description": "The current status of the port out.",
            "examples": [
              "issued"
            ]
          },
          "subscription": {
            "type": "string",
            "description": "Unique identifier of the subscription affected.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          },
          "user": {
            "type": "string",
            "description": "Unique identifier for the user this port out credentials are for.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "behavior",
          "completedAt",
          "createdAt",
          "subscription",
          "expirationRequestedAt",
          "expiredAt",
          "status",
          "user",
          "failureReason"
        ]
      },
      "deprecatedPortOutCredential": {
        "type": "object",
        "title": "DeprecatedPortOutCredentials",
        "properties": {
          "object": {
            "type": "string",
            "const": "portOutCredentials",
            "description": "Type of object is always `portOutCredentials`."
          },
          "accountNumber": {
            "type": "string",
            "description": "The account number on the service provider.",
            "examples": [
              "123456789"
            ]
          },
          "accountPin": {
            "type": [
              "string",
              "null"
            ],
            "description": "The account pin on the service provider. This value will always be null in all events.",
            "examples": [
              "1234"
            ]
          },
          "behavior": {
            "type": "string",
            "enum": [
              "cancelOnly",
              "portOut"
            ],
            "description": "The behavior of the port out credentials.\n\nA value of `portOut` indicates that using these\nport out credentials will transfer the phone number to the recipient provider.\n\nPort out credentials with behavior `cancelOnly`\nwill cancel the service without transferring the number. This behavior is\ncurrently only available for local plans in the United Kingdom.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              "portOut"
            ]
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the port-out credentials expire and won't be valid anymore.",
            "examples": [
              "2022-02-21T19:38:34Z"
            ]
          },
          "subscription": {
            "type": "string",
            "description": "Unique identifier of the subscription affected.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        },
        "required": [
          "object",
          "accountNumber",
          "accountPin",
          "behavior",
          "subscription",
          "expiresAt"
        ],
        "deprecated": true
      },
      "portOutCredentials": {
        "type": "object",
        "title": "PortOutCredentials",
        "description": "Port out credentials issued by network provider and used for the porting process at the target provider.",
        "properties": {
          "object": {
            "type": "string",
            "const": "portOutCredentials",
            "description": "Type of object is always `portOutCredentials`."
          },
          "accountNumber": {
            "type": [
              "string",
              "null"
            ],
            "description": "The account number on the service provider. Account number is `null` if no account number is issued in the respective country.",
            "examples": [
              "123456789"
            ]
          },
          "accountPin": {
            "type": "string",
            "description": "The account pin from the service provider.",
            "examples": [
              "1234"
            ]
          },
          "portOut": {
            "type": "string",
            "description": "Unique identifier of the port out this credentials are for.",
            "examples": [
              "pto_0SNlurA049MEWV4DWEaT4SaeDI8s"
            ]
          }
        },
        "required": [
          "object",
          "accountNumber",
          "accountPin",
          "portOut"
        ]
      },
      "price": {
        "type": "object",
        "title": "Price",
        "properties": {
          "amount": {
            "type": "integer",
            "description": "The price amount in the currency's minor unit, e.g. \"cents\" for many currencies.\n\nMost currencies have two decimals, so USD 9.99 is `999`. These currencies have a different number of decimals, e.g. JPY 28,500 is `28500`:\n\n- 0 decimals: CLP, ISK, JPY, KRW\n",
            "minimum": 0,
            "examples": [
              999
            ]
          },
          "currency": {
            "type": "string",
            "format": "ISO 4217",
            "description": "Three-letter ISO 4217 currency code. Must be a supported currency.",
            "examples": [
              "USD"
            ]
          }
        },
        "required": [
          "amount",
          "currency"
        ]
      },
      "project": {
        "type": "object",
        "title": "Project",
        "description": "A project is where all of the user, subscription, plan, device, and SIM information lives.",
        "properties": {
          "object": {
            "type": "string",
            "const": "project",
            "description": "Type of object is always `project`."
          },
          "id": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9-]{1,28}[a-z0-9]$",
            "description": "Globally unique identifier for the project.",
            "examples": [
              "gigs"
            ]
          },
          "billing": {
            "type": [
              "object",
              "null"
            ],
            "description": "Configuration parameters for the project use of billing. Present when the Billing API is enabled.",
            "properties": {
              "advanceInvoicingDays": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Number of days before renewal when invoices are generated. A value of `null` indicates that invoices are generated immediately after the renewal.",
                "examples": [
                  7
                ]
              },
              "invoiceGracePeriodDays": {
                "type": "integer",
                "description": "Number of days after renewal that an invoice can remain unpaid before it becomes overdue. After this period, the action specified in `invoiceOverdueAction` is triggered.",
                "examples": [
                  3
                ]
              },
              "invoiceOverdueDays": {
                "type": "integer",
                "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use `invoiceGracePeriodDays` instead.\n\n\nNumber of days after renewal that an invoice can remain unpaid before it becomes overdue. After this period, the action specified in `invoiceOverdueAction` is triggered.",
                "examples": [
                  3
                ],
                "deprecated": true
              },
              "invoiceOverduePeriodDays": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Number of days that invoices can remain overdue before subscriptions are ended. A value of `null` indicates that the subscriptions are ended at the end of the period.\n\nRelevant when subscriptions are not ended immediately after an invoice becomes overdue.\n",
                "examples": [
                  1
                ]
              },
              "invoiceOverdueAction": {
                "type": "string",
                "enum": [
                  "end",
                  "none",
                  "restrict"
                ],
                "description": "Indicates what happens to the subscription when a renewal invoice becomes overdue. One of:\n\n- `none`: Leave the subscription as is.\n- `end`: End the subscription immediately.\n- `restrict`: Restrict the subscription's connectivity.\n"
              },
              "currency": {
                "type": "string",
                "format": "ISO 4217",
                "description": "Three-letter ISO 4217 currency code representing the currency for the project use of billing. Must be a supported currency.",
                "examples": [
                  "USD"
                ]
              },
              "restrictBehavior": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  null,
                  "incomingOnly",
                  "noData",
                  "throttledData"
                ],
                "description": "Present when `invoiceOverdueAction` is `restrict`; nil otherwise.\nDetermines how subscriptions are restricted when an invoice becomes overdue. It can have one of the following values:\n\n- `incomingOnly`: The subscription line can receive calls & SMS, but cannot make calls, send SMS, or use data.\n- `noData`: The subscription line can make and receive calls & SMS, but cannot use data.\n- `throttledData`: The subscription line can still make and receive calls & SMS, and use up to 1GB of data at a reduced speed.\n"
              },
              "restoreBehavior": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  null,
                  "keepPeriodAnchor",
                  "resetPeriodAnchor"
                ],
                "description": "Present when `invoiceOverdueAction` is `restrict`; nil otherwise.\nDetermines how subscriptions are restored once a subscription is restored (e.g. after payment of an overdue invoice). It can have one of the following values:\n\n- `resetPeriodAnchor`: The subscription cycle is reset to the date of restoration. This means the user has a whole new period to use their plan allowance that was just restored.\n- `keepPeriodAnchor`: The subscription cycle remains unchanged. The next renewal date stays the same as before the restriction.\n"
              },
              "paymentBehavior": {
                "type": "string",
                "enum": [
                  "manual",
                  "none"
                ],
                "description": "Determines how invoices are paid. It can have one of the following values:\n\n- `manual`: Invoices are not automatically paid without explicit action.\n- `none`: No payment is performed and invoices are marked as paid automatically.\n"
              },
              "taxBehavior": {
                "type": "string",
                "enum": [
                  "exclusive",
                  "inclusive"
                ],
                "description": "Determines whether taxes are included in the product price. It can have one of the following values:\n\n- `exclusive`: Taxes are not included in the product price. The total amount is the sum of the product price and any applicable taxes.\n- `inclusive`: Taxes are already included in the product price. The total amount is the product price and the taxes are deducted from it.\n"
              },
              "recoveryFeePercentage": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "The recovery fee percentage to be applied to invoices for local plans in the United States.\nIf both `recoveryFeePercentage` and `recoveryFeeAmount` are `null`, a default percentage will be used.\nNote: `recoveryFeePercentage` and `recoveryFeeAmount` cannot both be present at the same time.\n",
                "maximum": 100,
                "minimum": 0,
                "examples": [
                  10
                ]
              },
              "recoveryFeeAmount": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/price"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The recovery fee amount to be added to invoices for local plans in the United States.\nIf both `recoveryFeePercentage` and `recoveryFeeAmount` are `null`, a default percentage will be used.\nNote: `recoveryFeePercentage` and `recoveryFeeAmount` cannot both be present at the same time.\n",
                "examples": [
                  {
                    "amount": 150,
                    "currency": "USD"
                  }
                ]
              }
            },
            "required": [
              "advanceInvoicingDays",
              "currency",
              "invoiceGracePeriodDays",
              "invoiceOverdueAction",
              "invoiceOverdueDays",
              "invoiceOverduePeriodDays",
              "paymentBehavior",
              "recoveryFeeAmount",
              "recoveryFeePercentage",
              "restrictBehavior",
              "restoreBehavior",
              "taxBehavior"
            ]
          },
          "consent": {
            "type": [
              "object",
              "null"
            ],
            "description": "Configuration parameters for the project's user consent collection. When absent, user consent is not checked or required.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "properties": {
              "deliveryMethods": {
                "type": "array",
                "description": "List of available delivery methods for consent requests.",
                "items": {
                  "type": "string",
                  "enum": [
                    "emailLink",
                    "sms",
                    "smsLink",
                    "smsOTP"
                  ]
                }
              },
              "approvalBaseUrl": {
                "type": "string",
                "format": "uri",
                "default": "https://consent.gigs.com/consent",
                "description": "Base URL for consent approvals the user opens as a link. Absent when none of `deliveryMethods` delivers one."
              }
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the project was created.",
            "examples": [
              "2021-01-21T19:32:13Z"
            ]
          },
          "image": {
            "type": [
              "string",
              "null"
            ],
            "description": "Small-resolution project icon with an aspect ratio of `1:1`.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              "https://a.gigscdn.net/p/gigs/icon.png"
            ]
          },
          "legal": {
            "type": [
              "object",
              "null"
            ],
            "description": "The legal address for the company that manages the project.",
            "properties": {
              "name": {
                "type": "string",
                "description": "The company's legal name.",
                "examples": [
                  "Gigs Inc."
                ]
              },
              "city": {
                "type": "string",
                "description": "The city/municipality of the address.",
                "examples": [
                  "New York City"
                ]
              },
              "country": {
                "type": "string",
                "description": "The ISO 3166-1 alpha-2 country code of the address.",
                "examples": [
                  "US"
                ]
              },
              "line1": {
                "type": "string",
                "description": "The first line of the address, e.g. street and house number.",
                "examples": [
                  "129 West 81st Street"
                ]
              },
              "line2": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The second line of the address, e.g. apartment number.",
                "examples": [
                  "Apartment 5"
                ]
              },
              "postalCode": {
                "type": "string",
                "description": "The postal code of the address.",
                "examples": [
                  "10024"
                ]
              },
              "state": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The state/province/region of the address.",
                "examples": [
                  "NY"
                ]
              }
            },
            "required": [
              "name",
              "city",
              "country",
              "line1",
              "line2",
              "postalCode",
              "state"
            ]
          },
          "locales": {
            "type": "array",
            "description": "List of supported locales represented as [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag), ordered by preference.",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "en-US"
              ]
            ]
          },
          "name": {
            "type": "string",
            "description": "A human-readable name for the project.",
            "examples": [
              "Gigs Connect"
            ]
          },
          "organization": {
            "$ref": "#/components/schemas/organization"
          },
          "payments": {
            "type": [
              "object",
              "null"
            ],
            "description": "Configuration parameters for the project use of payments.",
            "properties": {
              "currency": {
                "type": "string",
                "format": "ISO 4217",
                "description": "Three-letter ISO 4217 currency code representing the currency of the project. Must be a supported currency.",
                "examples": [
                  "USD"
                ]
              },
              "mode": {
                "type": "string",
                "enum": [
                  "live",
                  "test"
                ],
                "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This property is deprecated and will be removed in the future.\n> Use the root-level field `type` instead.\n\n\nThe mode in which the payments operate.",
                "deprecated": true
              }
            },
            "required": [
              "currency",
              "mode"
            ]
          },
          "subscriptionOwner": {
            "type": "string",
            "enum": [
              "user",
              "company"
            ],
            "description": "Indicates which entity will be registered as the owner of the subscription with the providers. When `company` is selected the legal address associated with the project will be used for the registration."
          },
          "support": {
            "type": [
              "object",
              "null"
            ],
            "description": "Contact details for consumer support requests regarding the project.",
            "properties": {
              "email": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "email",
                "description": "A publicly available email address for consumer support requests regarding the project.",
                "examples": [
                  "support@gigs.com"
                ]
              },
              "phoneNumber": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "E.164",
                "description": "A publicly available phone number in E.164 format for consumer support requests regarding the project.",
                "examples": [
                  "+12345678900"
                ]
              }
            },
            "required": [
              "email",
              "phoneNumber"
            ]
          },
          "tax": {
            "type": [
              "object",
              "null"
            ],
            "description": "Tax configuration for the project.",
            "properties": {
              "country": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The ISO 3166-1 alpha-2 country code for tax purposes. This will be used as the fallback country for tax calculations when a more specific country cannot be determined (e.g. user address).",
                "examples": [
                  "US"
                ]
              }
            },
            "required": [
              "country"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "live",
              "test"
            ],
            "description": "Indicates whether this is a live or test project. In live projects, subscriptions are invoiced to your organization, and any payments and taxes are real. The type cannot be changed after project creation.",
            "examples": [
              "live"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "billing",
          "consent",
          "image",
          "legal",
          "locales",
          "name",
          "organization",
          "payments",
          "subscriptionOwner",
          "support",
          "tax",
          "type",
          "createdAt"
        ]
      },
      "projectCredentials": {
        "type": "object",
        "title": "ProjectCredentials",
        "properties": {
          "object": {
            "type": "string",
            "const": "projectCredentials",
            "description": "Type of object is always `projectCredentials`."
          },
          "paymentsKey": {
            "type": [
              "string",
              "null"
            ],
            "description": "Publishable API key for payment integration.",
            "examples": [
              "pk_test_XXooYYauvdEDq12NiTphI7sa"
            ]
          }
        },
        "required": [
          "object",
          "paymentsKey"
        ]
      },
      "propertyErrorDetailError": {
        "type": "object",
        "title": "PropertyErrorDetail",
        "properties": {
          "object": {
            "type": "string",
            "const": "propertyErrorDetail",
            "description": "Type of object is always `propertyErrorDetail`."
          },
          "code": {
            "type": "string",
            "description": "A machine-readable description of the error.",
            "examples": [
              "propertyRequired"
            ]
          },
          "message": {
            "type": "string",
            "description": "A human readable description of the error.",
            "examples": [
              "Invalid value for property."
            ]
          },
          "property": {
            "type": "string",
            "description": "Name of the property associated with the error.",
            "examples": [
              "property1"
            ]
          },
          "suggestion": {
            "type": [
              "string",
              "null"
            ],
            "description": "Suggested alternative value for the field.",
            "examples": [
              "alternative_value"
            ]
          }
        },
        "required": [
          "object",
          "code",
          "message",
          "property",
          "suggestion"
        ]
      },
      "serviceProvider": {
        "type": "object",
        "title": "ServiceProvider",
        "properties": {
          "object": {
            "type": "string",
            "const": "serviceProvider",
            "description": "Type of object is always `serviceProvider`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the service provider.",
            "examples": [
              "svp_0SNlurA01K6GY5L0XJffY8"
            ]
          },
          "country": {
            "type": "string",
            "format": "ISO 3166-1 alpha-2",
            "description": "The ISO 3166-1 alpha-2 country code of the service provider.",
            "examples": [
              "US"
            ]
          },
          "name": {
            "type": "string",
            "description": "The name of the service provider, usually a brand name.",
            "examples": [
              "AT&T"
            ]
          },
          "recipientProviders": {
            "type": "array",
            "default": [
              "p3"
            ],
            "description": "List of network providers IDs that can receive portings from the service provider.",
            "items": {
              "type": "string",
              "examples": [
                "p3"
              ]
            }
          }
        },
        "required": [
          "object",
          "id",
          "country",
          "name",
          "recipientProviders"
        ]
      },
      "sim": {
        "type": "object",
        "title": "Sim",
        "description": "A SIM is a unique card that identifies itself to a specific mobile network and provides voice, text, and data connectivity to a user’s device. There are two types of available SIMs: eSIM and pSIM. eSIMs can be activated and installed instantly on any eSIM compatible device, pSIMs (physical SIMs) must be provided to the user or installed into the device beforehand.",
        "properties": {
          "object": {
            "type": "string",
            "const": "sim",
            "description": "Type of object is always `sim`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the SIM.",
            "examples": [
              "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/metadata"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the SIM was created.",
            "examples": [
              "2021-01-21T19:38:34Z"
            ]
          },
          "iccid": {
            "type": "string",
            "pattern": "^[0-9]{19,20}$",
            "description": "The ICCID (integrated circuit card identifier) associated with the SIM.",
            "examples": [
              "89883070000007537119"
            ]
          },
          "provider": {
            "type": "string",
            "description": "The ID of the network provider of the SIM.",
            "examples": [
              "p9"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "inactive",
              "active",
              "retired"
            ],
            "description": "The status of the SIM. Can be `active` or `inactive`."
          },
          "suspension": {
            "type": [
              "object",
              "null"
            ],
            "description": "The suspension of the SIM. A suspended SIM has no voice, SMS or data. `null` when the SIM is not suspended.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "suspended",
                  "suspending",
                  "unsuspending"
                ],
                "description": "The status of the suspension. It can have one of the following values:\n\n- `suspending`: The suspension was requested and the network provider has not confirmed it yet.\n- `suspended`: The network provider confirmed the suspension.\n- `unsuspending`: A request to unsuspend the SIM was made and the network provider has not confirmed it yet. The SIM still has no service.\n",
                "examples": [
                  "suspended"
                ]
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "description": "Time of the last transition of the suspension.",
                "examples": [
                  "2026-09-24T10:00:00Z"
                ]
              }
            },
            "required": [
              "status",
              "updatedAt"
            ],
            "examples": [
              null
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "eSIM",
              "pSIM"
            ],
            "description": "The type of the SIM. Can be `eSIM` or `pSIM`."
          }
        },
        "required": [
          "object",
          "id",
          "metadata",
          "iccid",
          "provider",
          "status",
          "suspension",
          "type",
          "createdAt"
        ]
      },
      "simCredentials": {
        "type": "object",
        "title": "SimCredentials",
        "properties": {
          "object": {
            "type": "string",
            "const": "simCredentials",
            "description": "Type of object is always `simCredentials`."
          },
          "activationCode": {
            "type": [
              "string",
              "null"
            ],
            "description": "eSIM activation code to download and install the profile in a device. Only available for type `eSIM`.",
            "examples": [
              "LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2"
            ]
          },
          "androidInstallUrl": {
            "type": [
              "string",
              "null"
            ],
            "description": "URL to install the eSIM profile on Android devices. Only available for type `eSIM`.\n\n<!-- theme: warning -->\n\n> Be careful how you share this URL, it contains the credentials required to install the eSIM profile.",
            "examples": [
              "https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2"
            ]
          },
          "iosInstallUrl": {
            "type": [
              "string",
              "null"
            ],
            "description": "URL to install the eSIM profile on iOS devices. Only available for type `eSIM`.\n\n<!-- theme: warning -->\n\n> Be careful how you share this URL, it contains the credentials required to install the eSIM profile.",
            "examples": [
              "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.gigs.com$2M-3L0MX-F8HE2"
            ]
          },
          "puk1": {
            "type": [
              "string",
              "null"
            ],
            "description": "The first PUK code for the SIM. Not available for all network providers.",
            "examples": [
              "12345678"
            ]
          },
          "puk2": {
            "type": [
              "string",
              "null"
            ],
            "description": "The second PUK code for the SIM. Not available for all network providers.",
            "examples": [
              "12345678"
            ]
          },
          "qrCodeUrl": {
            "type": [
              "string",
              "null"
            ],
            "description": "URL of the activation code in QR-Code format. Only available for type `eSIM`.\n\n<!-- theme: warning -->\n\n> Be careful how you share this URL, it can be accessed publicly without authentication.",
            "examples": [
              "https://files.gigs.com/qrcode/example/pUNIvfeLBNQ.png"
            ]
          },
          "sim": {
            "type": "string",
            "description": "Unique identifier for the SIM this credentials are for.",
            "examples": [
              "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
            ]
          }
        },
        "required": [
          "object",
          "activationCode",
          "androidInstallUrl",
          "iosInstallUrl",
          "puk1",
          "puk2",
          "qrCodeUrl",
          "sim"
        ]
      },
      "subscription": {
        "type": "object",
        "title": "Subscription",
        "description": "Subscriptions are tied to a user and are created once a user has a plan and SIM. This allows connectivity for their device and SIM.",
        "properties": {
          "object": {
            "type": "string",
            "const": "subscription",
            "description": "Type of object is always `subscription`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the subscription.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/metadata"
          },
          "activatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription was activated.",
            "examples": [
              "2021-01-21T19:38:34Z"
            ]
          },
          "billing": {
            "type": [
              "object",
              "null"
            ],
            "description": "Billing details for the subscription. Present when Billing is enabled on your project.",
            "properties": {
              "discount": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "Discount currently applied to the subscription. A discount created from a voucher with\nthe `once` recurrence type is used up by the first invoice it applies to, and is `null`\nafterwards. This includes the response to the request that applied it, and events\npublished later such as `subscription.activated`.\n",
                "properties": {
                  "voucher": {
                    "type": "string",
                    "description": "The voucher that was applied to create this discount.",
                    "examples": [
                      "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    ]
                  },
                  "expiresAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time",
                    "description": "Time when the discount expires. It may be in the past, if it has already expired.",
                    "examples": [
                      "2021-02-20T19:38:34Z"
                    ]
                  }
                },
                "required": [
                  "voucher",
                  "expiresAt"
                ]
              },
              "invoiceGracePeriodDays": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Number of days after renewal that an invoice can remain unpaid before it becomes overdue. After this period, the action specified in `invoiceOverdueAction` is triggered.\n\nWhen configured, this property takes precedence over the value set at the project level.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                "examples": [
                  3
                ]
              },
              "invoiceOverduePeriodDays": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Number of days that invoices can remain overdue before subscriptions are ended.\n\nRelevant when subscriptions are not ended immediately after an invoice becomes overdue.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
                "examples": [
                  1
                ]
              },
              "invoiceOverdueAction": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  null,
                  "end",
                  "none",
                  "restrict"
                ],
                "description": "Indicates what happens to the subscription when a renewal invoice becomes overdue. One of:\n\n- `none`: Leave the subscription as is.\n- `end`: End the subscription immediately.\n- `restrict`: Restrict the subscription's connectivity.\n\nWhen configured, this property takes precedence over the value set at the project level.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
              },
              "restrictBehavior": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  null,
                  "incomingOnly",
                  "noData",
                  "throttledData"
                ],
                "description": "Present when `invoiceOverdueAction` is `restrict`; nil otherwise.\nDetermines how subscriptions are restricted when an invoice becomes overdue. It can have one of the following values:\n\n- `incomingOnly`: The subscription line can receive calls & SMS, but cannot make calls, send SMS, or use data.\n- `noData`: The subscription line can make and receive calls & SMS, but cannot use data.\n- `throttledData`: The subscription line can still make and receive calls & SMS, and use up to 1GB of data at a reduced speed.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
              },
              "restoreBehavior": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  null,
                  "keepPeriodAnchor",
                  "resetPeriodAnchor"
                ],
                "description": "Present when `invoiceOverdueAction` is `restrict`; nil otherwise.\nDetermines how subscriptions are restored once a subscription is restored (e.g. after payment of an overdue invoice). It can have one of the following values:\n\n- `resetPeriodAnchor`: The subscription cycle is reset to the date of restoration. This means the user has a whole new period to use their plan allowance that was just restored.\n- `keepPeriodAnchor`: The subscription cycle remains unchanged. The next renewal date stays the same as before the restriction.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
              }
            },
            "required": [
              "discount",
              "invoiceGracePeriodDays",
              "invoiceOverduePeriodDays",
              "invoiceOverdueAction",
              "restrictBehavior",
              "restoreBehavior"
            ]
          },
          "canceledAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription was canceled.",
            "examples": [
              "2021-01-29T13:22:51Z"
            ]
          },
          "cancellationDetails": {
            "type": [
              "object",
              "null"
            ],
            "description": "Details about the cancellation of the subscription.",
            "properties": {
              "cause": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "cancellationRequested",
                  "deviceBlocked",
                  "deviceNotSupported",
                  "invoiceUnpaid",
                  "paymentDisputed",
                  "paymentFailed",
                  "phoneNumberExpired",
                  "phoneNumberPortedOut",
                  "portingExpired",
                  "projectDeleted",
                  "simSuspensionExpired",
                  "simUnusable",
                  "subscriptionEnded",
                  "suspectedPortOut",
                  "userDeleted"
                ],
                "description": "Cause of subscription cancellation."
              },
              "userComment": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Comment from the user explaining the cancellation reason. It is only present when the userReason is other."
              },
              "userReason": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "connectivityIssues",
                  "customerService",
                  "noDetails",
                  "other",
                  "tooExpensive",
                  "unused"
                ],
                "description": "Reason for the user to cancel the subscription. It is only present when the cause is cancellationRequested"
              }
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the subscription was created.",
            "examples": [
              "2021-01-21T19:32:13Z"
            ]
          },
          "currentPeriod": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/period"
              },
              {
                "type": "null"
              }
            ],
            "description": "Current subscription period. Only present for active subscriptions."
          },
          "earliestEndAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Earliest time at which the subscription can currently be ended. This\ndepends on the minimum period of the plan. This value is present after\nthe first period has already started, and before the subscription has\nended.\"\n",
            "examples": [
              "2021-02-20T19:38:34Z"
            ]
          },
          "endedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription will end or has ended. This field is populated in different scenarios:\n- When a subscription is canceled, this represents the future date when it will be terminated\n- When a subscription has already ended, this represents the past date when it was terminated\n- For active subscriptions, this field is null\n",
            "examples": [
              "2021-02-20T19:38:34Z"
            ]
          },
          "firstUsageAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription was first used.",
            "examples": [
              "2021-01-21T19:38:34Z"
            ]
          },
          "lastPorting": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/porting"
              },
              {
                "type": "null"
              }
            ],
            "description": "Last porting (if any) related with the subscription."
          },
          "phoneNumber": {
            "type": [
              "string",
              "null"
            ],
            "format": "E.164",
            "description": "The phone number attached to the SIM in E.164 string_format. Only available for voice plans.",
            "examples": [
              "+19591234567"
            ]
          },
          "plan": {
            "$ref": "#/components/schemas/plan"
          },
          "restoreRequestedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when a restore was requested for the subscription. It is set when a restore is accepted and cleared once the restore completes.",
            "examples": [
              "2021-02-21T19:38:34Z"
            ]
          },
          "restrictedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription was restricted.",
            "examples": [
              "2021-02-21T19:38:34Z"
            ]
          },
          "restrictionDetails": {
            "type": [
              "object",
              "null"
            ],
            "description": "Details about the restriction applied to the subscription. Present when the subscription is restricted.",
            "properties": {
              "restrictBehavior": {
                "type": "string",
                "enum": [
                  "incomingOnly",
                  "noData",
                  "throttledData"
                ],
                "description": "Determines how the subscription is restricted. It can have one of the following values:\n\n- `incomingOnly`: The subscription line can receive calls & SMS, but cannot make calls, send SMS, or use data.\n- `noData`: The subscription line can make and receive calls & SMS, but cannot use data.\n- `throttledData`: The subscription line can still make and receive calls & SMS, and use up to 1GB of data at a reduced speed.\n",
                "examples": [
                  "incomingOnly"
                ]
              },
              "restoreBehavior": {
                "type": "string",
                "enum": [
                  "keepPeriodAnchor",
                  "resetPeriodAnchor"
                ],
                "description": "Determines how the subscription is restored. It can have one of the following values:\n\n- `resetPeriodAnchor`: The subscription cycle is reset to the date of restoration. This means the user has a whole new period to use their plan allowance that was just restored.\n- `keepPeriodAnchor`: The subscription cycle remains unchanged. The next renewal date stays the same as before the restriction.\n",
                "examples": [
                  "resetPeriodAnchor"
                ]
              },
              "cause": {
                "type": "string",
                "enum": [
                  "invoiceOverdue",
                  "restrictionRequested"
                ],
                "description": "Determines the cause that triggered the subscription restriction. It can have one of the following values:\n\n- `invoiceOverdue`: The subscription was automatically restricted due to an unpaid invoice that has become overdue.\n- `restrictionRequested`: The subscription was manually restricted due to an explicit request.\n",
                "examples": [
                  "invoiceOverdue"
                ]
              }
            },
            "required": [
              "restrictBehavior",
              "restoreBehavior",
              "cause"
            ]
          },
          "sim": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/sim"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "initiated",
              "active",
              "restricted",
              "ended"
            ],
            "description": "The current status of the subscription. Note that the `initiated` status\nis currently only available when using the Billing API, where it implies\nthat the subscription's first invoice has not yet been paid.\n"
          },
          "user": {
            "$ref": "#/components/schemas/user"
          },
          "userAddress": {
            "type": [
              "string",
              "null"
            ],
            "description": "Current [user address](https://developers.gigs.com/core/user-addresses#the-user-address-resource) identifier (if any) related with the subscription.",
            "examples": [
              "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
            ]
          },
          "porting": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/porting"
              },
              {
                "type": "null"
              }
            ],
            "description": "First porting requested by the user. Refer to `lastPorting` to get the latest porting information.",
            "deprecated": true
          }
        },
        "required": [
          "object",
          "id",
          "metadata",
          "billing",
          "cancellationDetails",
          "currentPeriod",
          "lastPorting",
          "phoneNumber",
          "plan",
          "restrictionDetails",
          "sim",
          "status",
          "user",
          "userAddress",
          "porting",
          "activatedAt",
          "restrictedAt",
          "restoreRequestedAt",
          "canceledAt",
          "createdAt",
          "earliestEndAt",
          "endedAt",
          "firstUsageAt"
        ]
      },
      "subscriptionAddon": {
        "type": "object",
        "title": "SubscriptionAddon",
        "description": "Subscription add-ons are features or top-ups that extend the functionality offered to the end user through their subscription, as defined by the associated add-on.",
        "properties": {
          "object": {
            "type": "string",
            "const": "subscriptionAddon",
            "description": "Type of object is always `subscriptionAddon`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the subscription add-on.",
            "examples": [
              "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
            ]
          },
          "activatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription add-on was activated.",
            "examples": [
              "2021-01-15T12:36:57Z"
            ]
          },
          "addon": {
            "$ref": "#/components/schemas/addon",
            "description": "The add-on associated to the subscription add-on."
          },
          "billing": {
            "type": [
              "object",
              "null"
            ],
            "description": "Billing details for the subscription add-on. Present when the add-on has billing settings.",
            "properties": {
              "discount": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "Discount currently applied to the subscription add-on. A discount created from a voucher\nwith the `once` recurrence type is used up by the first invoice it applies to, and is\n`null` afterwards. This includes the response to the request that applied it and events\npublished later.\n",
                "properties": {
                  "voucher": {
                    "type": "string",
                    "description": "The voucher that was applied to create this discount.",
                    "examples": [
                      "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
                    ]
                  },
                  "expiresAt": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date-time",
                    "description": "Time when the discount expires. It may be in the past, if it has already expired.",
                    "examples": [
                      "2021-02-20T19:38:34Z"
                    ]
                  }
                },
                "required": [
                  "voucher",
                  "expiresAt"
                ]
              }
            },
            "required": [
              "discount"
            ]
          },
          "canceledAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription add-on was canceled.",
            "examples": [
              "2021-01-22T19:39:53Z"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the subscription add-on was created.",
            "examples": [
              "2021-01-15T12:30:28Z"
            ]
          },
          "currentPeriod": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/period"
              },
              {
                "type": "null"
              }
            ],
            "description": "Current subscription add-on period. The value is `null` unless the subscription add-on is active. For a recurring add-on, `number` counts from `1` to the add-on's `validity.totalPeriods`, and each period lasts one validity period of the add-on, the first one starting when the subscription add-on was activated."
          },
          "endedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription add-on will end or has ended. This field is populated in different scenarios:\n- For an active recurring add-on, this represents the future date when its last period ends. It is set shortly after activation\n- When a subscription add-on has ended, this represents the past date when it ended\n- Otherwise, this field is null\n",
            "examples": [
              "2021-01-30T23:12:28Z"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "initiated",
              "active",
              "ended"
            ],
            "description": "The current status of the subscription add-on.\n\n- `initiated`: Created, but waiting on a prerequisite (typically an unpaid invoice) before it can be activated.\n- `pending`: Cleared to activate and awaiting provisioning on the network provider.\n- `active`: Provisioned and usable.\n- `ended`: Terminated, for example when its allowance is used up, its validity elapses, or it is removed.\n"
          },
          "subscription": {
            "type": "string",
            "description": "Unique identifier of the subscription the add-on applies to.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          },
          "user": {
            "type": "string",
            "description": "Unique identifier of the user the subscription add-on belongs to.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "addon",
          "billing",
          "currentPeriod",
          "status",
          "subscription",
          "user",
          "activatedAt",
          "createdAt",
          "endedAt",
          "canceledAt"
        ]
      },
      "subscriptionChange": {
        "type": "object",
        "title": "SubscriptionChange",
        "description": "Any change to a user’s subscription, such as swapping a SIM, or upgrading or downgrading a subscription.",
        "properties": {
          "object": {
            "type": "string",
            "const": "subscriptionChange",
            "description": "Type of object is always `subscriptionChange`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the subscription change.",
            "examples": [
              "sch_0SNlurA049MEWV3bE0SMtbIEJApp"
            ]
          },
          "appliedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription change was applied.",
            "examples": [
              "2021-01-21T19:36:57Z"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the subscription change was created.",
            "examples": [
              "2021-01-21T19:12:28Z"
            ]
          },
          "failureCode": {
            "type": [
              "string",
              "null"
            ],
            "description": "An error code indicating the reason for a failed subscription change.",
            "examples": [
              "consentNotGiven"
            ]
          },
          "plan": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/plan"
              },
              {
                "type": "null"
              }
            ],
            "description": "The plan to which the subscription should be changed."
          },
          "requestedChange": {
            "type": "object",
            "description": "Object with the requested changes.",
            "properties": {
              "plan": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Unique identifier of the target plan, to which the subscription should be changed. The new plan must have the same type of validity as the one it's replacing. E.g. a `oneTime` plan cannot be replaced by a `recurring` one. If the new plan's validity has a different `unit` or `value` than the plan it's replacing, then the change must be scheduled for the next renewal. See property `\"when\"` for more information about scheduling options for subscription change.",
                "examples": [
                  "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                ]
              },
              "sim": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Unique identifier of the target SIM, to which the subscription should be changed. Can also be set to \"auto\", in which case an eSIM will be automatically allocated.",
                "examples": [
                  "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                ]
              },
              "phoneNumber": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Set to \"auto\" when the subscription's phone number should be changed to a new one assigned by the network provider.",
                "examples": [
                  "auto"
                ]
              },
              "when": {
                "type": "string",
                "enum": [
                  "now",
                  "renewal"
                ],
                "description": "When the change should take effect. If set to `\"now\"`, the change will take effect immediately. If set to `\"renewal\"`, the change will instead take effect at the next subscription renewal date. Plan changes can always happen on `\"renewal\"`, but only selected network providers allow `\"now\"` changes. SIM changes can only happen `\"now\"`.",
                "examples": [
                  "renewal"
                ]
              }
            },
            "required": [
              "sim",
              "plan",
              "phoneNumber",
              "when"
            ]
          },
          "scheduledAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Approximate time when the change should take place. This is typically set for changes scheduled at renewal. For changes that take effect immediately (when `requestedChange.when` is `\"now\"`), this may be null.",
            "examples": [
              "2021-01-21T19:12:28Z"
            ]
          },
          "sim": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/sim"
              },
              {
                "type": "null"
              }
            ],
            "description": "The SIM to which the subscription should be changed."
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "initiated",
              "applied",
              "failed",
              "deleted"
            ],
            "description": "The current status of the subscription change. Note that the `initiated` status\nis currently only available when using the Billing API, where it implies that\nthe subscription change invoice has not yet been paid.\n"
          },
          "subscription": {
            "type": [
              "string",
              "null"
            ],
            "description": "Unique identifier of the subscription to be changed.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "failureCode",
          "plan",
          "requestedChange",
          "scheduledAt",
          "sim",
          "status",
          "subscription",
          "appliedAt",
          "createdAt"
        ]
      },
      "subscriptionGroup": {
        "type": "object",
        "title": "SubscriptionGroup",
        "description": "A subscription group represents a collection of subscriptions.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This schema is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "subscriptionGroup",
            "description": "Type of object is always `subscriptionGroup`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the subscription group.",
            "examples": [
              "sgr_0SNlurA049MEWV26leJMWPp4o23C"
            ]
          },
          "subscriptions": {
            "type": "array",
            "description": "List of subscription identifiers that belong to this group.",
            "items": {
              "type": "string",
              "examples": [
                "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
              ]
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "discountGroup",
              "familyPlan"
            ],
            "description": "The type of the subscription group. The object with the same name holds the fields of that type.",
            "examples": [
              "familyPlan"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "draft"
            ],
            "description": "The status of the subscription group.",
            "examples": [
              "active"
            ]
          },
          "discountGroup": {
            "type": [
              "object",
              "null"
            ],
            "description": "Fields of a group with the `discountGroup` type. Only present when `type` is `discountGroup`.",
            "properties": {}
          },
          "familyPlan": {
            "type": [
              "object",
              "null"
            ],
            "description": "Fields of a group with the `familyPlan` type. Only present when `type` is `familyPlan`.",
            "properties": {
              "primarySubscription": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The subscription that receives the consent requests for the other subscriptions in the group. Cannot be changed once the group is active.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "plan": {
                "type": "string",
                "description": "The plan that every subscription in the family plan must be on. Cannot be changed after creation.",
                "examples": [
                  "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                ]
              }
            },
            "required": [
              "primarySubscription",
              "plan"
            ]
          },
          "activatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the subscription group was activated. A discount group is activated when it is created. A family plan is activated through the activate subscription group endpoint. It is null while the family plan is a draft.",
            "examples": [
              "2021-01-21T19:38:34Z"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the subscription group was created.",
            "examples": [
              "2021-01-21T19:32:13Z"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "subscriptions",
          "type",
          "status",
          "activatedAt",
          "createdAt"
        ]
      },
      "usageBalance": {
        "type": "object",
        "title": "UsageBalance",
        "description": "A usage balance represents the amount of usage consumed from an [Allowance](https://developers.gigs.com/core/schemas/allowance) for a given [Subscription](https://developers.gigs.com/core/subscriptions#the-subscription-resource) in a certain Period.",
        "properties": {
          "object": {
            "type": "string",
            "const": "usageBalance",
            "description": "Type of object is always `usageBalance`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the usage balance.",
            "examples": [
              "ubl_0V9n0zo90CE0NuvcsN0j88"
            ]
          },
          "allowance": {
            "$ref": "#/components/schemas/allowance",
            "description": "The [Allowance](https://developers.gigs.com/core/schemas/allowance) this usage balance is tracking."
          },
          "subscription": {
            "type": "string",
            "description": "Unique identifier of the [Subscription](https://developers.gigs.com/core/subscriptions#the-subscription-resource) the usage balance is related to.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          },
          "source": {
            "$ref": "#/components/schemas/usageBalanceSource",
            "description": "The entity providing the allowance to the [Subscription](https://developers.gigs.com/core/subscriptions#the-subscription-resource)."
          },
          "unit": {
            "type": "string",
            "enum": [
              "bytes",
              "seconds",
              "messages"
            ],
            "description": "The unit the usage is counted in."
          },
          "used": {
            "type": "integer",
            "description": "The amount of usage consumed, counted in `unit`.",
            "examples": [
              230
            ]
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The amount of usage permitted by the associated allowance counted in `unit`. A value of `null` indicates an unlimited allowance.",
            "examples": [
              500
            ]
          },
          "remaining": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The amount remaining that can still be consumed, counted in `unit`. A value of `null` indicates an unlimited allowance.",
            "examples": [
              270
            ]
          },
          "usedPercent": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The percentage of `limit` that has been used, expressed as an integer between 0 and 100. A value of `null` indicates an unlimited allowance.",
            "examples": [
              46
            ]
          },
          "remainingPercent": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The percentage of `limit` that has not been used, expressed as an integer between 0 and 100. A value of `null` indicates an unlimited allowance.",
            "examples": [
              54
            ]
          },
          "usableFrom": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Timestamp representing the beginning of this usage balance's validity. A value of `null` indicates a Balance that is not yet active, for example when a Subscription is still pending.",
            "examples": [
              "2026-01-03T13:41:24Z"
            ]
          },
          "usableUntil": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Timestamp representing the end of this usage balance's validity. A value of `null` indicates a Balance that is not yet active, for example when a Subscription is still pending.",
            "examples": [
              "2026-02-03T13:41:24Z"
            ]
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time at which any of the usage balance's properties were last updated.",
            "examples": [
              "2026-01-15T08:12:51Z"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "allowance",
          "subscription",
          "source",
          "unit",
          "used",
          "limit",
          "remaining",
          "usedPercent",
          "remainingPercent",
          "usableFrom",
          "usableUntil",
          "updatedAt"
        ],
        "examples": [
          {
            "object": "usageBalance",
            "id": "ubl_0V9n0zo90CE0NuvcsN0j88",
            "allowance": {
              "object": "allowance",
              "id": "alw_0SNlurA049MEWV3OMTRrGKbd99GH",
              "name": "Roaming data in Europe",
              "type": "data",
              "coverage": {
                "object": "coverage",
                "id": "de",
                "countries": [
                  "DE",
                  "FR",
                  "US"
                ],
                "name": "Europe"
              },
              "limit": 500,
              "unit": "bytes",
              "priority": 1
            },
            "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
            "source": {
              "type": "subscriptionPeriod",
              "subscriptionPeriod": 4,
              "subscriptionAddon": null
            },
            "unit": "bytes",
            "used": 230,
            "limit": 500,
            "remaining": 270,
            "usedPercent": 46,
            "remainingPercent": 54,
            "usableFrom": "2026-01-03T13:41:24Z",
            "usableUntil": "2026-02-03T13:41:24Z",
            "updatedAt": "2026-01-15T08:12:51Z"
          }
        ]
      },
      "usageBalanceSource": {
        "type": "object",
        "title": "UsageBalanceSource",
        "description": "The entity providing the [Allowance](https://developers.gigs.com/core/allowances#the-allowance-resource) to the [Subscription](https://developers.gigs.com/core/subscriptions#the-subscription-resource).",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "subscriptionPeriod",
              "subscriptionAddon"
            ],
            "description": "The entity type providing the allowance."
          },
          "subscriptionPeriod": {
            "type": [
              "integer",
              "null"
            ],
            "description": "When the allowance is provided by the subscription's plan, the subscription period this usage balance is bound by.",
            "examples": [
              4
            ]
          },
          "subscriptionAddon": {
            "type": [
              "string",
              "null"
            ],
            "description": "When the allowance is provided by a [Subscription Add-on](https://developers.gigs.com/core/subscription-add-ons#the-subscription-add-on-resource), the subscription add-on this usage balance is provided by.",
            "examples": [
              "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
            ]
          }
        },
        "required": [
          "type"
        ],
        "examples": [
          {
            "type": "subscriptionPeriod",
            "subscriptionPeriod": 4,
            "subscriptionAddon": null
          },
          {
            "type": "subscriptionAddon",
            "subscriptionPeriod": null,
            "subscriptionAddon": "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
          }
        ]
      },
      "usageRecord": {
        "type": "object",
        "title": "UsageRecord",
        "description": "Usage records track subscription usage for users. This includes data, voice, and text usage. Note that there is a delay in usage data that varies between carriers.",
        "properties": {
          "object": {
            "type": "string",
            "const": "usageRecord",
            "description": "Type of object is always `usageRecord`."
          },
          "data": {
            "type": "integer",
            "description": "Amount of data used in bytes.",
            "examples": [
              18883100
            ]
          },
          "dataDeviceBytes": {
            "type": "integer",
            "description": "Amount of on-device data used in bytes.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              30029300
            ]
          },
          "dataTetheringBytes": {
            "type": "integer",
            "description": "Amount of tethering data used in bytes.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              30029300
            ]
          },
          "end": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp representing the exclusive upper bound of the aggregation period (e.g. the end of a 24 hour period, subscription period or user-defined set of dates).",
            "examples": [
              "2021-02-15T00:00:00Z"
            ]
          },
          "labels": {
            "type": "object",
            "description": "An object containing optional metadata about the usage record.",
            "properties": {
              "country": {
                "type": "string",
                "description": "The ISO 3166-1 alpha-2 country code of the country in which the usage occurred.",
                "examples": [
                  "US"
                ]
              },
              "roaming": {
                "type": "string",
                "enum": [
                  "none",
                  "international",
                  "domestic"
                ],
                "description": "The roaming mode the usage occurred in.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n"
              },
              "subscription": {
                "type": "string",
                "description": "The unique identifier for the subscription to which the usage is attributed.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              }
            },
            "required": [],
            "additionalProperties": true
          },
          "sms": {
            "type": "integer",
            "description": "Amount of SMS messages sent and received.",
            "examples": [
              15
            ]
          },
          "smsInternationalMessages": {
            "type": "integer",
            "description": "Amount of SMS messages sent internationally.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              6
            ]
          },
          "smsLocalMessages": {
            "type": "integer",
            "description": "Amount of SMS messages sent locally.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              6
            ]
          },
          "start": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp representing the inclusive lower bound of the aggregation period (e.g. the start of a 24 hour period, subscription period or user-defined set of dates)",
            "examples": [
              "2021-02-14T00:00:00Z"
            ]
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The time at which the aggregation was last updated.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              "2024-02-15T12:13:14Z"
            ]
          },
          "voice": {
            "type": "integer",
            "description": "Amount of voice usage in seconds.",
            "examples": [
              240
            ]
          },
          "voiceInternationalSeconds": {
            "type": "integer",
            "description": "Amount of international voice usage in seconds.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              125
            ]
          },
          "voiceLocalSeconds": {
            "type": "integer",
            "description": "Amount of local voice usage in seconds.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              6
            ]
          }
        },
        "required": [
          "object",
          "data",
          "end",
          "labels",
          "sms",
          "start",
          "voice"
        ]
      },
      "user": {
        "type": "object",
        "title": "User",
        "description": "Users are end consumers of subscriptions. Users can have multiple devices, SIMs, and subscriptions.",
        "properties": {
          "object": {
            "type": "string",
            "const": "user",
            "description": "Type of object is always `user`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the user.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/metadata"
          },
          "birthday": {
            "type": [
              "string",
              "null"
            ],
            "format": "date",
            "description": "The birthday of the user.",
            "examples": [
              "2017-07-21"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the user was created.",
            "examples": [
              "2021-01-21T19:38:34Z"
            ]
          },
          "email": {
            "type": "string",
            "format": "email",
            "description": "The primary email address of the user. Must be unique across all users.",
            "examples": [
              "jerry@example.com"
            ]
          },
          "emailVerified": {
            "type": "boolean",
            "description": "Whether the user's primary email address is verified or not.",
            "examples": [
              true
            ]
          },
          "fullName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The user's full name. Required for some Plans.",
            "examples": [
              "Jerry Seinfeld"
            ]
          },
          "preferredLocale": {
            "type": "string",
            "description": "The user's locale preference represented as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag).",
            "examples": [
              "en-US"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "blocked",
              "deleted"
            ],
            "description": "The current status of the user."
          }
        },
        "required": [
          "object",
          "id",
          "metadata",
          "birthday",
          "email",
          "emailVerified",
          "fullName",
          "preferredLocale",
          "createdAt",
          "status"
        ]
      },
      "userAddress": {
        "type": "object",
        "title": "UserAddress",
        "properties": {
          "object": {
            "type": "string",
            "const": "userAddress",
            "description": "Type of object is always `userAddress`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the address.",
            "examples": [
              "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
            ]
          },
          "city": {
            "type": "string",
            "description": "The city/municipality of the address.",
            "examples": [
              "New York City"
            ]
          },
          "country": {
            "type": "string",
            "description": "The ISO 3166-1 alpha-2 country code of the address.",
            "examples": [
              "US"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The time the address was created.",
            "examples": [
              "2021-01-21T19:38:34Z"
            ]
          },
          "line1": {
            "type": "string",
            "description": "The first line of the address, e.g. street and house number.",
            "examples": [
              "129 West 81st Street"
            ]
          },
          "line2": {
            "type": [
              "string",
              "null"
            ],
            "description": "The second line of the address, e.g. apartment number.",
            "examples": [
              "Apartment 5"
            ]
          },
          "postalCode": {
            "type": [
              "string",
              "null"
            ],
            "description": "The postal code of the address.",
            "examples": [
              "10024"
            ]
          },
          "state": {
            "type": [
              "string",
              "null"
            ],
            "description": "The state/province/region of the address.",
            "examples": [
              "NY"
            ]
          },
          "user": {
            "type": "string",
            "description": "Unique identifier for the address user.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "city",
          "country",
          "line1",
          "line2",
          "postalCode",
          "state",
          "user",
          "createdAt"
        ]
      },
      "virtualNumber": {
        "type": "object",
        "title": "VirtualNumber",
        "description": "Virtual numbers are additional numbers that can be added for a user. Any calls made or texts sent to an active virtual number will be received by the primary number of the `subscription`. Note that this is an experimental feature that is only available in select projects.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This schema is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "virtualNumber",
            "description": "Type of object is always `virtualNumber`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the virtual number.",
            "examples": [
              "vnr_0SNlurA049MEWV29mxRtSMDnKtUD"
            ]
          },
          "activatedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the virtual number was activated.",
            "examples": [
              "2020-01-01T00:00:07Z"
            ]
          },
          "canceledAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the virtual number was canceled.",
            "examples": [
              "2020-07-15T00:00:00Z"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the virtual number was created.",
            "examples": [
              "2020-01-01T00:00:00Z"
            ]
          },
          "endedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the virtual number will end or has ended. This field is populated in different scenarios:\n- When a virtual number is canceled, this represents the future date when it will be terminated\n- When a virtual number has already ended, this represents the past date when it was terminated\n",
            "examples": [
              "2020-08-01T00:00:00Z"
            ]
          },
          "phoneNumber": {
            "type": [
              "string",
              "null"
            ],
            "format": "E.164",
            "description": "The virtual phone number.",
            "examples": [
              "+447700900000"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "ended",
              "initiated",
              "processing"
            ],
            "description": "The current status of the virtual number.",
            "examples": [
              "active"
            ]
          },
          "subscription": {
            "type": "string",
            "description": "Unique identifier for the subscription this virtual number belongs to.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          },
          "user": {
            "type": "string",
            "description": "Unique identifier for the user this virtual number belongs to.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "activatedAt",
          "canceledAt",
          "createdAt",
          "endedAt",
          "phoneNumber",
          "status",
          "subscription",
          "user"
        ]
      },
      "creditNote": {
        "type": "object",
        "title": "CreditNote",
        "description": "Credit notes adjust an invoice amount after it has been finalized. Used to issue credit or refunds.",
        "properties": {
          "object": {
            "type": "string",
            "const": "creditNote",
            "description": "Type of object is always `creditNote`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the credit note.",
            "examples": [
              "crn_0SNlurA049MEWV49X25tqzNV2jji"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/metadata"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the credit note was created.",
            "examples": [
              "2024-06-14T19:38:34Z"
            ]
          },
          "creditTo": {
            "type": "string",
            "enum": [
              "outOfBand",
              "pspRefund",
              "userBalance"
            ],
            "description": "Specifies where the credit amount should be credited to. It can have one of the following values:\n\n  - `outOfBand`: The amount should be handled outside the system by the customer.\n  - `pspRefund`: The amount will be refunded by Gigs through to the payment service provider used to pay the invoice.\n  - `userBalance`: The amount should be added to the user balance at Gigs.\n"
          },
          "fees": {
            "type": "array",
            "description": "The credited fees.",
            "items": {
              "type": "object",
              "properties": {
                "amount": {
                  "$ref": "#/components/schemas/price",
                  "description": "The amount of the fee.",
                  "examples": [
                    {
                      "amount": 100,
                      "currency": "USD"
                    }
                  ]
                },
                "name": {
                  "type": "string",
                  "description": "The name of the fee.",
                  "examples": [
                    "Recovery Fee"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "recoveryFee"
                  ],
                  "description": "The type of the fee."
                }
              },
              "required": [
                "amount",
                "name",
                "type"
              ]
            }
          },
          "fileUrl": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri",
            "description": "A signed URL to download the credit note PDF file.\nThe URL is valid for 1 minute.\n\nThis field is `null` for projects without billing enabled,\nfor credit notes covering US-taxed plans, and for credit notes whose\ninvoice was not issued by Gigs as the merchant of record.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              "https://files.gigs.com/creditNotes/crn_0SNlurA049MEWV49X25tqzNV2jji.pdf?signature=abc123"
            ]
          },
          "invoice": {
            "type": "string",
            "description": "The unique identifier for the invoice that the credit note applies to.",
            "examples": [
              "inv_0SNlurA049MEWV1QTRqvd18YuG25"
            ]
          },
          "lineItems": {
            "type": "array",
            "description": "The line items for the credit note.",
            "items": {
              "type": "object",
              "title": "CreditNoteLineItem",
              "properties": {
                "amount": {
                  "$ref": "#/components/schemas/price",
                  "description": "The amount credited for this line item before taxes.",
                  "examples": [
                    {
                      "amount": 999,
                      "currency": "USD"
                    }
                  ]
                },
                "invoiceLineItem": {
                  "type": "string",
                  "description": "The unique identifier for the invoice line item that the line item applies to.",
                  "examples": [
                    "lin_0SNlurA049MEWV11QUKZGDMxJmKe"
                  ]
                },
                "tax": {
                  "$ref": "#/components/schemas/price",
                  "description": "The sum of the amount in taxes credited for this line item.",
                  "examples": [
                    {
                      "amount": 200,
                      "currency": "USD"
                    }
                  ]
                },
                "taxes": {
                  "type": "array",
                  "description": "The taxes credited for this line item.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "amount": {
                        "$ref": "#/components/schemas/price",
                        "description": "The amount credited for this tax.",
                        "examples": [
                          {
                            "amount": 200,
                            "currency": "USD"
                          }
                        ]
                      },
                      "invoiceTax": {
                        "type": "string",
                        "description": "Unique identifier of the invoice's line item tax being credited.",
                        "examples": [
                          "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                        ]
                      }
                    },
                    "required": [
                      "amount",
                      "invoiceTax"
                    ]
                  }
                },
                "total": {
                  "$ref": "#/components/schemas/price",
                  "description": "The total amount credited for this line item after taxes.",
                  "examples": [
                    {
                      "amount": 1199,
                      "currency": "USD"
                    }
                  ]
                }
              },
              "required": [
                "amount",
                "invoiceLineItem",
                "tax",
                "taxes",
                "total"
              ]
            }
          },
          "number": {
            "type": [
              "string",
              "null"
            ],
            "description": "The sequential number identifying this credit note, unique across all Gigs credit notes and immutable once assigned.\n\nCredit notes have their own number series, separate from invoices, so a credit note and the invoice it credits never share a number. It is case-sensitive.\n",
            "examples": [
              "3l4rLP-DE-CN-2026-06-10001"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "issued",
              "voided"
            ],
            "description": "The status of the credit note. It can have one of the following values:\n\n  - `issued`: The credit note was issued.\n  - `voided`: The credit note was voided and no longer has any effect.\n"
          },
          "subtotal": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount credited before any taxes or fees.",
            "examples": [
              {
                "amount": 999,
                "currency": "USD"
              }
            ]
          },
          "tax": {
            "$ref": "#/components/schemas/price",
            "description": "The sum of the amounts in taxes credited for each line item.",
            "examples": [
              {
                "amount": 200,
                "currency": "USD"
              }
            ]
          },
          "total": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount credited after taxes and fees.",
            "examples": [
              {
                "amount": 1199,
                "currency": "USD"
              }
            ]
          },
          "voidedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the credit note was voided.",
            "examples": [
              "2024-06-14T19:38:34Z"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "metadata",
          "creditTo",
          "fees",
          "fileUrl",
          "invoice",
          "lineItems",
          "number",
          "status",
          "subtotal",
          "tax",
          "total",
          "createdAt",
          "voidedAt"
        ]
      },
      "invoice": {
        "type": "object",
        "title": "Invoice",
        "description": "Invoices describe the amount due to a user for a given subscription period, including any relevant taxes and fees.",
        "properties": {
          "object": {
            "type": "string",
            "const": "invoice",
            "description": "Type of object is always `invoice`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the invoice.",
            "examples": [
              "inv_0SNlurA049MEWV1QTRqvd18YuG25"
            ]
          },
          "address": {
            "type": [
              "string",
              "null"
            ],
            "description": "The unique identifier for the address this invoice relates to.",
            "examples": [
              "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
            ]
          },
          "appliedBalance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/price"
              },
              {
                "type": "null"
              }
            ],
            "description": "The amount of user balance applied to pay this invoice.",
            "examples": [
              {
                "amount": 1199,
                "currency": "USD"
              }
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the invoice was created.",
            "examples": [
              "2024-01-09T15:00:51Z"
            ]
          },
          "discount": {
            "$ref": "#/components/schemas/price",
            "description": "The total discount applied. This is the sum of the discounts of each line item.",
            "examples": [
              {
                "amount": 100,
                "currency": "USD"
              }
            ]
          },
          "dueAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the invoice is due to be paid. After this time and the `invoiceGracePeriodDays`, which can be configured on project or subscription level, the invoice becomes overdue.\n\nThis field will have a value for invoices in the `finalized` state that have a reason of `subscriptionRenewal`. For all other invoices, this field will be `null`.\n",
            "examples": [
              "2024-02-01T11:12:13Z"
            ]
          },
          "expiresAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the overdue period ends and the subscription is ended.\n\nThis field will have a value once a `finalized` invoice enters its overdue period. For all other invoices, this field will be `null`.\n",
            "examples": [
              "2024-02-11T11:13:13Z"
            ]
          },
          "fees": {
            "type": "array",
            "description": "The fees for the invoice.",
            "items": {
              "type": "object",
              "properties": {
                "amount": {
                  "$ref": "#/components/schemas/price",
                  "description": "The amount of the fee.",
                  "examples": [
                    {
                      "amount": 100,
                      "currency": "USD"
                    }
                  ]
                },
                "name": {
                  "type": "string",
                  "description": "The name of the fee.",
                  "examples": [
                    "Recovery Fee"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "recoveryFee"
                  ],
                  "description": "The type of the fee."
                }
              },
              "required": [
                "amount",
                "name",
                "type"
              ]
            }
          },
          "fileUrl": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri",
            "description": "A signed URL to download the invoice PDF file.\nThe URL is valid for 1 minute.\n\nThis field is `null` for invoices that haven't been finalized,\nfor projects without billing enabled, for invoices covering\nUS-taxed plans, and for invoices where Gigs is not the merchant\nof record.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This property is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
            "examples": [
              "https://files.gigs.com/invoices/inv_0SNlurA049MEWV1QTRqvd18YuG25.pdf?signature=abc123"
            ]
          },
          "finalizedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the invoice was finalized and could no longer be changed.",
            "examples": [
              "2024-02-01T11:12:13Z"
            ]
          },
          "lineItems": {
            "type": "array",
            "description": "The line items that make up the invoice.",
            "items": {
              "type": "object",
              "title": "InvoiceLineItem",
              "properties": {
                "object": {
                  "type": "string",
                  "const": "invoiceLineItem",
                  "description": "Type of object is always `invoiceLineItem`."
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier for this line item.",
                  "examples": [
                    "lin_0SNlurA049MEWV11QUKZGDMxJmKe"
                  ]
                },
                "addon": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the addon this line item refers to, if any. Either plan or addon will be present, but not both.",
                  "examples": [
                    "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
                  ]
                },
                "creditedPlan": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the credited plan this line item refers to, if any. The value of the credited plan price is subtracted to calculate the line item amount. Only present for line items created for invoices of subscription changes.",
                  "examples": [
                    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                  ]
                },
                "discount": {
                  "$ref": "#/components/schemas/price",
                  "description": "The discount applied to this line item.",
                  "examples": [
                    {
                      "amount": 100,
                      "currency": "USD"
                    }
                  ]
                },
                "plan": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the plan this line item refers to, if any. Either plan or addon will be present, but not both.",
                  "examples": [
                    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                  ]
                },
                "subscription": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the subscription this line item refers to. Present for line items with plans.",
                  "examples": [
                    "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                  ]
                },
                "subscriptionAddon": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the subscription addon this line item refers to. Present for line items with addons.",
                  "examples": [
                    "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                  ]
                },
                "subscriptionChange": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the subscription change this line item refers to. Present for line items that were created for an invoice of a subscription change.",
                  "examples": [
                    "sch_0SNlurA049MEWV3bE0SMtbIEJApp"
                  ]
                },
                "subtotal": {
                  "$ref": "#/components/schemas/price",
                  "description": "The price of the line item before any discounts or taxes are applied.",
                  "examples": [
                    {
                      "amount": 999,
                      "currency": "USD"
                    }
                  ]
                },
                "tax": {
                  "$ref": "#/components/schemas/price",
                  "description": "The total amount of taxes applied to this line item.",
                  "examples": [
                    {
                      "amount": 200,
                      "currency": "USD"
                    }
                  ]
                },
                "taxes": {
                  "type": "array",
                  "description": "The taxes applied to this line item.",
                  "items": {
                    "type": "object",
                    "title": "InvoiceTax",
                    "properties": {
                      "object": {
                        "type": "string",
                        "const": "invoiceTax",
                        "description": "Type of object is always `invoiceTax`."
                      },
                      "id": {
                        "type": "string",
                        "description": "Unique identifier for the invoice tax.",
                        "examples": [
                          "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
                        ]
                      },
                      "amount": {
                        "$ref": "#/components/schemas/price",
                        "description": "The amount of the tax.",
                        "examples": [
                          {
                            "amount": 200,
                            "currency": "USD"
                          }
                        ]
                      },
                      "inclusive": {
                        "type": "boolean",
                        "default": false,
                        "description": "Whether the tax is included in the product price or not.",
                        "examples": [
                          false
                        ]
                      },
                      "jurisdiction": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The optional jurisdiction of the tax.",
                        "examples": [
                          "Federal"
                        ]
                      },
                      "name": {
                        "type": "string",
                        "description": "The name of the tax.",
                        "examples": [
                          "Federal TRS Fund"
                        ]
                      }
                    },
                    "required": [
                      "object",
                      "id",
                      "amount",
                      "inclusive",
                      "jurisdiction",
                      "name"
                    ]
                  }
                },
                "total": {
                  "$ref": "#/components/schemas/price",
                  "description": "The total amount for this line item after all discounts and taxes are applied.",
                  "examples": [
                    {
                      "amount": 1099,
                      "currency": "USD"
                    }
                  ]
                }
              },
              "required": [
                "object",
                "id",
                "addon",
                "creditedPlan",
                "discount",
                "plan",
                "subscription",
                "subscriptionAddon",
                "subscriptionChange",
                "subtotal",
                "tax",
                "taxes",
                "total"
              ]
            }
          },
          "number": {
            "type": [
              "string",
              "null"
            ],
            "description": "The sequential number identifying this invoice, unique across all Gigs invoices and immutable once assigned.\n\nThe number is assigned when the invoice is finalized, so a draft never has one. It is case-sensitive.\n",
            "examples": [
              "3l4rLP-DE-2026-06-10001"
            ]
          },
          "overdueAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the invoice is considered overdue. Once this happens, `invoiceOverdueAction`, which can be configured on project or subscription level, is applied.\n\nThis field will have a value for invoices in the `finalized` state that have a reason of `subscriptionRenewal`. For all other invoices, this field will be `null`.\n",
            "examples": [
              "2024-02-01T11:13:13Z"
            ]
          },
          "paidAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the invoice was paid.",
            "examples": [
              "2024-02-01T11:13:13Z"
            ]
          },
          "payment": {
            "type": [
              "string",
              "null"
            ],
            "description": "The unique identifier for the payment associated with the invoice, if any. Only present if the invoice has been paid using Gigs Payments.",
            "examples": [
              "pay_0SNlurA049MEWV2HRA0slWFuS8DV"
            ]
          },
          "period": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/period"
              },
              {
                "type": "null"
              }
            ],
            "description": "The subscription period that this invoice relates to. It might not be present for new subscriptions if the period has not been defined yet."
          },
          "reason": {
            "type": "string",
            "enum": [
              "other",
              "subscriptionChange",
              "subscriptionCreation",
              "subscriptionRenewal",
              "subscriptionRestore"
            ],
            "description": "The reason this invoice was created. It can have one of the following values:\n\n  - `subscriptionCreation`: The invoice is due to a new subscription.\n  - `subscriptionRenewal`: The invoice is due to a recurring subscription renewal.\n  - `subscriptionChange`: The invoice is due to a subscription change (e.g. plan upgrade).\n  - `subscriptionRestore`: The invoice is due to a subscription restore.\n  - `other`: The invoice is not related to a subscription but due an e.g. one-time addon.\n"
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "finalized",
              "paid",
              "voided"
            ],
            "description": "The status of the invoice. It can have one of the following values:\n\n  - `draft`: The invoice is still being edited.\n  - `finalized`: The invoice can no longer be changed and is awaiting payment.\n  - `paid`: The invoice was paid. This causes the associated resources to activated.\n  - `voided`: The invoice was voided and no longer has any effect.\n",
            "examples": [
              "draft"
            ]
          },
          "subscription": {
            "type": "string",
            "description": "The unique identifier for the subscription that this invoice relates to.",
            "examples": [
              "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
            ]
          },
          "subtotal": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount before any discounts, taxes or fees are applied.",
            "examples": [
              {
                "amount": 999,
                "currency": "USD"
              }
            ]
          },
          "tax": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount of taxes. This is the sum of the taxes of each line item.",
            "examples": [
              {
                "amount": 200,
                "currency": "USD"
              }
            ]
          },
          "taxExemptionReason": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              null,
              "calculationFailed",
              "fullyDiscounted",
              "inclusiveTaxExceedsPrice",
              "userExempted"
            ],
            "description": "The reason for the invoice having no taxes calculated, if any. It can have one of the following values:\n\n  - `calculationFailed`: The tax calculation failed for an unspecified reason.\n  - `fullyDiscounted`: The invoice is fully discounted due to a voucher or a free product.\n  - `inclusiveTaxExceedsPrice`: The calculated tax is too large to be included in the price.\n  - `userExempted`: The user is marked as exempted from taxes.\n",
            "examples": [
              "calculationFailed"
            ]
          },
          "total": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount after all discounts, taxes and fees are applied.",
            "examples": [
              {
                "amount": 1199,
                "currency": "USD"
              }
            ]
          },
          "voucher": {
            "type": [
              "string",
              "null"
            ],
            "description": "The unique identifier for the voucher applied to the invoice, if any.",
            "examples": [
              "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "address",
          "appliedBalance",
          "discount",
          "dueAt",
          "expiresAt",
          "fees",
          "fileUrl",
          "lineItems",
          "number",
          "overdueAt",
          "payment",
          "period",
          "reason",
          "status",
          "subscription",
          "subtotal",
          "tax",
          "taxExemptionReason",
          "total",
          "voucher",
          "createdAt",
          "finalizedAt",
          "paidAt"
        ]
      },
      "quote": {
        "type": "object",
        "title": "Quote",
        "description": "Quotes provide a preview of the invoices, including taxes and fees, that will occur when creating a subscription or add-on.",
        "properties": {
          "object": {
            "type": "string",
            "const": "quote",
            "description": "Type of object is always `quote`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the quote.",
            "examples": [
              "quo_0SNlurA049MEWV2X9NicYieFQ4Kc"
            ]
          },
          "address": {
            "type": [
              "string",
              "null"
            ],
            "description": "The unique identifier for the address that the taxes were quoted for. Present when quoting local plans.",
            "examples": [
              "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the quote was created.",
            "examples": [
              "2024-01-09T15:00:51Z"
            ]
          },
          "discount": {
            "$ref": "#/components/schemas/price",
            "description": "The total discount applied. This is the sum of the discounts of each line item.",
            "examples": [
              {
                "amount": 100,
                "currency": "USD"
              }
            ]
          },
          "expiredAt": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp indicating when the quote expires. Set to 2 hours after the quote's creation time.",
            "examples": [
              "2024-02-01T11:12:13Z"
            ]
          },
          "fees": {
            "type": "array",
            "description": "The fees for the quote.",
            "items": {
              "type": "object",
              "properties": {
                "amount": {
                  "$ref": "#/components/schemas/price",
                  "description": "The amount of the fee.",
                  "examples": [
                    {
                      "amount": 100,
                      "currency": "USD"
                    }
                  ]
                },
                "name": {
                  "type": "string",
                  "description": "The name of the fee.",
                  "examples": [
                    "Recovery Fee"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "recoveryFee"
                  ],
                  "description": "The type of the fee."
                }
              },
              "required": [
                "amount",
                "name",
                "type"
              ]
            }
          },
          "lineItems": {
            "type": "array",
            "description": "The line items that make up the quote.",
            "items": {
              "type": "object",
              "title": "QuoteLineItem",
              "properties": {
                "addon": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the addon this line item refers to, if any. Either plan or addon will be present, but not both.",
                  "examples": [
                    "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
                  ]
                },
                "creditedPlan": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the credited plan this line item refers to, if any. The price of the credited plan is used to adjust the final plan price when quoting immediate subscription changes. Only present for line items generated as part of a subscription change quote.",
                  "examples": [
                    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                  ]
                },
                "discount": {
                  "$ref": "#/components/schemas/price",
                  "description": "The discount applied to this line item.",
                  "examples": [
                    {
                      "amount": 100,
                      "currency": "USD"
                    }
                  ]
                },
                "plan": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The unique identifier for the plan this line item refers to, if any. Either plan or addon will be present, but not both.",
                  "examples": [
                    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                  ]
                },
                "subtotal": {
                  "$ref": "#/components/schemas/price",
                  "description": "The price of the line item before any discounts or taxes are applied.",
                  "examples": [
                    {
                      "amount": 999,
                      "currency": "USD"
                    }
                  ]
                },
                "tax": {
                  "$ref": "#/components/schemas/price",
                  "description": "The total amount of taxes applied to this line item.",
                  "examples": [
                    {
                      "amount": 200,
                      "currency": "USD"
                    }
                  ]
                },
                "taxes": {
                  "type": "array",
                  "description": "The taxes applied to this line item.",
                  "items": {
                    "type": "object",
                    "title": "QuoteTax",
                    "properties": {
                      "amount": {
                        "$ref": "#/components/schemas/price",
                        "description": "The amount of the tax.",
                        "examples": [
                          {
                            "amount": 200,
                            "currency": "USD"
                          }
                        ]
                      },
                      "inclusive": {
                        "type": "boolean",
                        "default": false,
                        "description": "Whether the tax is included in the product price or not.",
                        "examples": [
                          false
                        ]
                      },
                      "jurisdiction": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The optional jurisdiction of the tax.",
                        "examples": [
                          "Federal"
                        ]
                      },
                      "name": {
                        "type": "string",
                        "description": "The name of the tax.",
                        "examples": [
                          "Federal TRS Fund"
                        ]
                      }
                    },
                    "required": [
                      "amount",
                      "inclusive",
                      "jurisdiction",
                      "name"
                    ]
                  }
                },
                "total": {
                  "$ref": "#/components/schemas/price",
                  "description": "The total amount for this line item after all discounts or taxes are applied.",
                  "examples": [
                    {
                      "amount": 1099,
                      "currency": "USD"
                    }
                  ]
                }
              },
              "required": [
                "addon",
                "creditedPlan",
                "discount",
                "plan",
                "subtotal",
                "tax",
                "taxes",
                "total"
              ]
            }
          },
          "reason": {
            "type": "string",
            "enum": [
              "other",
              "subscriptionChange",
              "subscriptionCreation"
            ],
            "description": "The reason this quote was created. It can have one of the following values:\n\n  - `subscriptionCreation`: The quote is for a new subscription.\n  - `subscriptionChange`: The quote is for a subscription change (e.g. plan upgrade).\n  - `other`: The quote is not related to a subscription but due an e.g. one-time addon.\n"
          },
          "subtotal": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount before any discounts, taxes or fees are applied.",
            "examples": [
              {
                "amount": 999,
                "currency": "USD"
              }
            ]
          },
          "tax": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount of taxes. This is the sum of the taxes of each line item.",
            "examples": [
              {
                "amount": 200,
                "currency": "USD"
              }
            ]
          },
          "taxExemptionReason": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              null,
              "calculationFailed",
              "fullyDiscounted",
              "inclusiveTaxExceedsPrice",
              "userExempted"
            ],
            "description": "The reason for the taxes not being calculated, if any. It can have one of the following values:\n\n  - `calculationFailed`: The tax calculation failed for an unspecified reason.\n  - `inclusiveTaxExceedsPrice`: The calculated tax is too large to be included in the price.\n  - `fullyDiscounted`: The quote is fully discounted due to a voucher or a free product.\n  - `userExempted`: The user is marked as exempted from taxes.\n",
            "examples": [
              "calculationFailed"
            ]
          },
          "total": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount after all discounts, taxes and fees are applied.",
            "examples": [
              {
                "amount": 1199,
                "currency": "USD"
              }
            ]
          },
          "user": {
            "type": "string",
            "description": "The unique identifier for the user that this quote belongs to.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          },
          "voucher": {
            "type": [
              "string",
              "null"
            ],
            "description": "The unique identifier for the voucher applied to the quote, if any.",
            "examples": [
              "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "address",
          "discount",
          "fees",
          "lineItems",
          "reason",
          "subtotal",
          "tax",
          "taxExemptionReason",
          "total",
          "user",
          "voucher",
          "createdAt",
          "expiredAt"
        ]
      },
      "voucher": {
        "type": "object",
        "title": "Voucher",
        "description": "Vouchers describe the discounts to apply to quotes and subscriptions.",
        "properties": {
          "object": {
            "type": "string",
            "const": "voucher",
            "description": "Type of object is always `voucher`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the voucher.",
            "examples": [
              "vou_0SNlurA049MEWV0h2jfjkdiOdplN"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the voucher was created.",
            "examples": [
              "2021-02-14T19:38:34Z"
            ]
          },
          "name": {
            "type": "string",
            "description": "The voucher's name.",
            "examples": [
              "Black Friday"
            ]
          },
          "priceDiscount": {
            "type": [
              "object",
              "null"
            ],
            "description": "The price amount of the discount applied via the voucher. A voucher object has always either a priceDiscount or a priceDiscountPercentage.",
            "properties": {
              "amount": {
                "type": "integer",
                "description": "The discount amount in the currency's minor unit, e.g. \"cents\" for many currencies.\n\nMost currencies have two decimals, so USD 9.99 is `999`. These currencies have a different number of decimals, e.g. JPY 28,500 is `28500`:\n\n- 0 decimals: CLP, ISK, JPY, KRW\n",
                "minimum": 1,
                "examples": [
                  999
                ]
              },
              "currency": {
                "type": "string",
                "format": "ISO 4217",
                "description": "Three-letter ISO 4217 currency code. Must be a supported currency.",
                "examples": [
                  "USD"
                ]
              }
            },
            "required": [
              "amount",
              "currency"
            ]
          },
          "priceDiscountPercentage": {
            "type": [
              "number",
              "null"
            ],
            "description": "The percentage amount of the discount applied via the voucher. A voucher object has always either a priceDiscount or a priceDiscountPercentage.",
            "maximum": 100,
            "minimum": 1,
            "examples": [
              30.12
            ]
          },
          "recurrence": {
            "type": "object",
            "description": "Details on whether and for how long the discounts applied via the voucher recur.",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "once",
                  "repeating",
                  "forever"
                ],
                "description": "Whether and how the voucher discount recurs.",
                "examples": [
                  "once"
                ]
              },
              "durationInMonths": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "For how many months is the discount applied via the voucher. Only applicable when 'recurrence.type' is 'repeating'.",
                "minimum": 1
              }
            },
            "required": [
              "type",
              "durationInMonths"
            ]
          },
          "redemptions": {
            "type": "integer",
            "description": "Number of times the voucher has been redeemed.",
            "examples": [
              2
            ]
          },
          "retiredReason": {
            "type": [
              "null",
              "string"
            ],
            "enum": [
              null,
              "manualAction",
              "expired",
              "maxRedemptionsReached",
              "unknown"
            ],
            "description": "Label indicating the reason why the voucher is retired."
          },
          "status": {
            "type": "string",
            "enum": [
              "available",
              "retired"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "name",
          "priceDiscount",
          "priceDiscountPercentage",
          "recurrence",
          "redemptions",
          "retiredReason",
          "status",
          "createdAt"
        ]
      },
      "payment": {
        "type": "object",
        "title": "Payment",
        "description": "Payments describe the amount charged for an order or subscription using a given payment method.",
        "properties": {
          "object": {
            "type": "string",
            "const": "payment",
            "description": "Type of object is always `payment`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the payment.",
            "examples": [
              "pay_0SNlurA049MEWV2HRA0slWFuS8DV"
            ]
          },
          "amount": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount charged for this payment.",
            "examples": [
              {
                "amount": 990,
                "currency": "USD"
              }
            ]
          },
          "attemptedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the payment was last attempted. `null` if the payment has never been attempted.",
            "examples": [
              "2021-02-14T19:38:34Z"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the payment was created.",
            "examples": [
              "2021-02-14T19:38:34Z"
            ]
          },
          "disputeClosedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the payment dispute was closed. Only present if the payment is disputed.",
            "examples": [
              "2021-02-14T19:38:34Z"
            ]
          },
          "disputeOutcome": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              null,
              "lost",
              "won"
            ],
            "description": "The outcome of a payment dispute. Only present if the payment is disputed."
          },
          "failedAttempts": {
            "type": "integer",
            "description": "The number of failed payment attempts so far.",
            "minimum": 0,
            "examples": [
              3
            ]
          },
          "failureCode": {
            "type": [
              "string",
              "null"
            ],
            "description": "An error code indicating the reason for the payment failure. Only present if the payment failed.",
            "examples": [
              "paymentCardDeclined"
            ]
          },
          "failureMessage": {
            "type": [
              "string",
              "null"
            ],
            "description": "A human-readable message indicating the reason for the payment failure. Only present if the payment failed.",
            "examples": [
              "The card has been declined."
            ]
          },
          "method": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/paymentMethod"
              },
              {
                "type": "null"
              }
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "subscriptionCreation",
              "subscriptionRenewal",
              "other"
            ],
            "description": "The reason for this payment. It can have one of the following values:\n\n        - `subscriptionCreation`: The payment is due to a new subscription.\n        - `subscriptionRenewal`: The payment is due to a recurring subscription renewal.\n        - `other`: The invoice is not related to a subscription but due an e.g. one-time addon.\n      "
          },
          "references": {
            "type": "array",
            "description": "List of payment references. Supported reference types are `order` and `subscription`.",
            "items": {
              "type": "object",
              "properties": {
                "object": {
                  "type": "string",
                  "enum": [
                    "order",
                    "subscription",
                    "subscriptionAddon"
                  ],
                  "description": "The type of the referenced object."
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier of the referenced object.",
                  "examples": [
                    "ord_0SNlurA049MEWV0SiRFOw0dmChqN"
                  ]
                }
              },
              "required": [
                "object",
                "id"
              ]
            }
          },
          "refunded": {
            "$ref": "#/components/schemas/price",
            "description": "The total amount refunded from this payment.",
            "examples": [
              {
                "amount": 0,
                "currency": "USD"
              }
            ]
          },
          "refundedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Time when the payment was fully refunded. Only present if the payment was refunded.",
            "examples": [
              "2021-02-14T19:38:34Z"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "succeeded",
              "requiresConfirmation",
              "failed",
              "refunded",
              "disputed",
              "requiresPaymentMethod"
            ],
            "description": "The status of the payment. It can have one of the following values:\n\n        - `pending`: The payment has been created but not yet processed by the payment provider.\n        - `succeeded`: The payment was completed successfully.\n        - `failed`: The payment failed. Payments are retried automatically for up to 3 weeks.\n        - `refunded`: The payment was fully refunded. Partially refunded payments do not have this status.\n        - `disputed`: The payment is under dispute.\n        - `requiresConfirmation`: The payment requires user confirmation before being processed.\n        - `requiresPaymentMethod`: The payment is awaiting for a payment method to be attached.\n      "
          },
          "user": {
            "$ref": "#/components/schemas/user"
          }
        },
        "required": [
          "object",
          "id",
          "amount",
          "disputeOutcome",
          "failedAttempts",
          "failureCode",
          "failureMessage",
          "method",
          "reason",
          "references",
          "refunded",
          "status",
          "user",
          "attemptedAt",
          "createdAt",
          "disputeClosedAt",
          "refundedAt"
        ]
      },
      "paymentMethod": {
        "type": "object",
        "title": "PaymentMethod",
        "description": "Payment methods are used to process payments for subscriptions and orders.",
        "properties": {
          "object": {
            "type": "string",
            "const": "paymentMethod",
            "description": "Type of object is always `paymentMethod`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the payment method.",
            "examples": [
              "pm_1IHCiiI2m82Dc6YnhqGWH6JX"
            ]
          },
          "brand": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "amex",
              "diners",
              "discover",
              "jcb",
              "mastercard",
              "unionpay",
              "visa",
              "unknown"
            ],
            "description": "Card brand. Only available for type `card`.",
            "examples": [
              "visa"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the payment method was created.",
            "examples": [
              "2021-02-14T19:38:34Z"
            ]
          },
          "last4": {
            "type": [
              "string",
              "null"
            ],
            "description": "The last four digits of the card. Only available for type `card`.",
            "examples": [
              "4242"
            ]
          },
          "provider": {
            "type": "string",
            "const": "stripe",
            "description": "The provider of the payment method. Currently only `stripe` is supported."
          },
          "status": {
            "type": "string",
            "enum": [
              "available",
              "requiresConfirmation",
              "deleted",
              "replaced"
            ],
            "description": "The status of the payment method. It can have one of the following values:\n\n        - `available`: The payment method is available for processing payments.\n        - `requiresConfirmation`: The payment method requires user confirmation before being able to process payments.\n        - `deleted`: The payment method has been deleted. This value appears in `paymentMethod.deleted` events and in the response to `DELETE /paymentMethods/{id}`; deleted payment methods cannot be fetched via GET.\n        - `replaced`: The payment method has been replaced by another payment method with the same card details. This value appears in payment method events; replaced payment methods cannot be fetched via GET.\n      ",
            "examples": [
              "available"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "card",
              "applePay",
              "googlePay"
            ],
            "description": "Type of the payment method.",
            "examples": [
              "card"
            ]
          },
          "user": {
            "type": "string",
            "description": "Unique identifier for the user of the payment method.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "brand",
          "last4",
          "provider",
          "status",
          "type",
          "user",
          "createdAt"
        ]
      },
      "connectSession": {
        "type": "object",
        "title": "ConnectSession",
        "properties": {
          "object": {
            "type": "string",
            "const": "connectSession",
            "description": "Type of object is always `connectSession`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the Connect Session.",
            "examples": [
              "csn_0SNlurA049MEWV1GWxpaE5D0t2D6"
            ]
          },
          "appearance": {
            "type": "object",
            "title": "Appearance",
            "properties": {
              "theme": {
                "type": "string",
                "enum": [
                  "light",
                  "dark"
                ],
                "description": "The theme setting that will influence the visual appearance during the Connect Session.",
                "examples": [
                  "light"
                ]
              }
            },
            "required": []
          },
          "callbackUrl": {
            "type": [
              "string",
              "null"
            ],
            "description": "The URL to which the user will be redirected after the Connect Session is completed.",
            "examples": [
              "https://example.com"
            ]
          },
          "intent": {
            "type": "object",
            "title": "Intent",
            "properties": {
              "browseDataPackages": {
                "type": "object",
                "properties": {
                  "plan": {
                    "type": "string",
                    "description": "The unique identifier for the plan to browse data packages for.",
                    "examples": [
                      "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                    ]
                  }
                },
                "required": [
                  "plan"
                ]
              },
              "cancelSubscription": {
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to cancel.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "changeSubscription": {
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to modify.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "checkoutAddon": {
                "type": "object",
                "properties": {
                  "addons": {
                    "type": "array",
                    "description": "List of unique identifiers for the add-ons to subscribe.",
                    "items": {
                      "type": "string",
                      "examples": [
                        "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
                      ]
                    }
                  },
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to modify.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "addons",
                  "subscription"
                ]
              },
              "checkoutNewSubscription": {
                "type": "object",
                "properties": {
                  "device": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the existing device to use.",
                    "examples": [
                      "dev_0SNlurA049MEWV55CrA9qMvI2FVJ"
                    ]
                  },
                  "plan": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the plan to subscribe.",
                    "examples": [
                      "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                    ]
                  },
                  "sim": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the SIM to use.",
                    "examples": [
                      "sim_0SNlurA049MEWV1BAAmWZULA4lf6"
                    ]
                  },
                  "imei": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^[0-9]{15,16}$",
                    "description": "The IMEI (international mobile equipment identity) of the corresponding device.",
                    "examples": [
                      "492388841798923"
                    ]
                  },
                  "voucherCode": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "Applies a voucher code to the session. The voucher code is visible to the user in the payment step. It can be overwritten by defining a URL query parameter or by the user directly.",
                    "examples": [
                      "PROMO10"
                    ]
                  }
                }
              },
              "completePorting": {
                "type": "object",
                "properties": {
                  "behavior": {
                    "type": "object",
                    "title": "Complete Porting: Behavior",
                    "description": "Behavior flags that customize the Complete Porting flow in Connect.",
                    "properties": {
                      "hideIntroPage": {
                        "type": "boolean",
                        "description": "When true, skips the intro screen in the Complete Porting intent and navigates users directly to the first required step.",
                        "examples": [
                          true
                        ]
                      },
                      "hideOutroPage": {
                        "type": "boolean",
                        "description": "When true, hides the outro screen after the Complete Porting intent is fullfilled and returns users immediately to the `callbackUrl` (if provided).",
                        "examples": [
                          true
                        ]
                      }
                    },
                    "required": []
                  },
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to complete porting.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "behavior",
                  "subscription"
                ]
              },
              "confirmPayment": {
                "type": "object",
                "properties": {
                  "payment": {
                    "type": "string",
                    "description": "The unique identifier for the payment to be confirmed.",
                    "examples": [
                      "pay_0SNlurA049MEWV2HRA0slWFuS8DV"
                    ]
                  }
                },
                "required": [
                  "payment"
                ]
              },
              "evergreenRoaming": {
                "type": "object",
                "properties": {
                  "plan": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the plan. The flow opens the user's latest subscription on this plan, or creates one. Mutually exclusive with `subscription`. Cannot be combined with `entryPoint`.",
                    "examples": [
                      "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                    ]
                  },
                  "subscription": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the subscription. Mutually exclusive with `plan`.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  },
                  "entryPoint": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "browseDataPackages",
                      "viewEsimInstallation",
                      "manageDataPackages"
                    ],
                    "description": "The entry point for the evergreen roaming flow.",
                    "examples": [
                      "browseDataPackages"
                    ]
                  }
                }
              },
              "manageDataPackages": {
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to manage data packages for.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "replaceSim": {
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to replace the SIM in.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "requestSupport": {
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The unique identifier for the subscription to request support for.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                }
              },
              "resumeSubscription": {
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to resume.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "browseDataPackages",
                  "cancelSubscription",
                  "changeSubscription",
                  "checkoutAddon",
                  "checkoutNewSubscription",
                  "completePorting",
                  "confirmPayment",
                  "evergreenRoaming",
                  "manageDataPackages",
                  "replaceSim",
                  "requestSupport",
                  "resumeSubscription",
                  "updatePaymentMethod",
                  "updateUserAddress",
                  "updateUserFullName",
                  "viewEsimInstallation",
                  "viewSubscription",
                  "viewSubscriptions"
                ],
                "description": "The type of intent."
              },
              "viewEsimInstallation": {
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to view eSIM installation.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  },
                  "entryPoint": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "another-device",
                      "manual"
                    ],
                    "description": "The entry point for the eSIM installation flow.",
                    "examples": [
                      "manual"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              },
              "viewSubscription": {
                "type": "object",
                "properties": {
                  "subscription": {
                    "type": "string",
                    "description": "The unique identifier for the subscription to view.",
                    "examples": [
                      "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                    ]
                  }
                },
                "required": [
                  "subscription"
                ]
              }
            },
            "required": [
              "type"
            ]
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "The session URL. Redirect your users to this URL to take them to Connect. It is only present on all create responses or in the update responses that associate the session with a user. It should not be stored, logged or exposed to anyone other than the user.",
            "examples": [
              "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp"
            ]
          },
          "user": {
            "type": [
              "string",
              "null"
            ],
            "description": "The unique identifier of the user that the session is for.",
            "examples": [
              "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "appearance",
          "callbackUrl",
          "intent",
          "url",
          "user"
        ]
      },
      "com.gigs.apiKey.created": {
        "type": "object",
        "title": "com.gigs.apiKey.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/apiKey"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.apiKey.created",
            "description": "Type is always `com.gigs.apiKey.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.apiKey.deleted": {
        "type": "object",
        "title": "com.gigs.apiKey.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/apiKey"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.apiKey.deleted",
            "description": "Type is always `com.gigs.apiKey.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.addon.archived": {
        "type": "object",
        "title": "com.gigs.addon.archived",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/addon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.addon.archived",
            "description": "Type is always `com.gigs.addon.archived`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.addon.created": {
        "type": "object",
        "title": "com.gigs.addon.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/addon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.addon.created",
            "description": "Type is always `com.gigs.addon.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.addon.deleted": {
        "type": "object",
        "title": "com.gigs.addon.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/addon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.addon.deleted",
            "description": "Type is always `com.gigs.addon.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.addon.published": {
        "type": "object",
        "title": "com.gigs.addon.published",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/addon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.addon.published",
            "description": "Type is always `com.gigs.addon.published`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.addon.updated": {
        "type": "object",
        "title": "com.gigs.addon.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/addon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.addon.updated",
            "description": "Type is always `com.gigs.addon.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.connectSession.created": {
        "type": "object",
        "title": "com.gigs.connectSession.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/connectSession"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.connectSession.created",
            "description": "Type is always `com.gigs.connectSession.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.connectSession.updated": {
        "type": "object",
        "title": "com.gigs.connectSession.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/connectSession"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.connectSession.updated",
            "description": "Type is always `com.gigs.connectSession.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.consentRequest.approved": {
        "type": "object",
        "title": "com.gigs.consentRequest.approved",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/consentRequest"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.consentRequest.approved",
            "description": "Type is always `com.gigs.consentRequest.approved`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.consentRequest.canceled": {
        "type": "object",
        "title": "com.gigs.consentRequest.canceled",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/consentRequest"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.consentRequest.canceled",
            "description": "Type is always `com.gigs.consentRequest.canceled`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.consentRequest.created": {
        "type": "object",
        "title": "com.gigs.consentRequest.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/consentRequest"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.consentRequest.created",
            "description": "Type is always `com.gigs.consentRequest.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.consentRequest.expired": {
        "type": "object",
        "title": "com.gigs.consentRequest.expired",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/consentRequest"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.consentRequest.expired",
            "description": "Type is always `com.gigs.consentRequest.expired`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.consentRequest.updated": {
        "type": "object",
        "title": "com.gigs.consentRequest.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/consentRequest"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.consentRequest.updated",
            "description": "Type is always `com.gigs.consentRequest.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.creditNote.created": {
        "type": "object",
        "title": "com.gigs.creditNote.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/creditNote"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.creditNote.created",
            "description": "Type is always `com.gigs.creditNote.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.creditNote.updated": {
        "type": "object",
        "title": "com.gigs.creditNote.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/creditNote"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.creditNote.updated",
            "description": "Type is always `com.gigs.creditNote.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.creditNote.voided": {
        "type": "object",
        "title": "com.gigs.creditNote.voided",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/creditNote"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.creditNote.voided",
            "description": "Type is always `com.gigs.creditNote.voided`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.device.created": {
        "type": "object",
        "title": "com.gigs.device.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/device"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.device.created",
            "description": "Type is always `com.gigs.device.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.device.deleted": {
        "type": "object",
        "title": "com.gigs.device.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/device"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.device.deleted",
            "description": "Type is always `com.gigs.device.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.device.updated": {
        "type": "object",
        "title": "com.gigs.device.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/device"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.device.updated",
            "description": "Type is always `com.gigs.device.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.eSimProfile.deleted": {
        "type": "object",
        "title": "com.gigs.eSimProfile.deleted",
        "description": "Fires when the eSIM profile is deleted. Only available for providers `p3`, `p11`, `p14`, `p15` and `p18`.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/eSimProfile"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.eSimProfile.deleted",
            "description": "Type is always `com.gigs.eSimProfile.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.eSimProfile.disabled": {
        "type": "object",
        "title": "com.gigs.eSimProfile.disabled",
        "description": "Fires when the eSIM profile is disabled. Note that if the eSIM being\ndisabled results in the device losing connectivity, this event will be\ndelayed until connectivity is regained.\n\nOnly available for providers `p3`, `p11`, `p14`, `p15` and `p18`.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/eSimProfile"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.eSimProfile.disabled",
            "description": "Type is always `com.gigs.eSimProfile.disabled`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.eSimProfile.downloadFailed": {
        "type": "object",
        "title": "com.gigs.eSimProfile.downloadFailed",
        "description": "Fires when the eSIM profile fails to download to a device. Only available for selected providers.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/eSimProfile"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.eSimProfile.downloadFailed",
            "description": "Type is always `com.gigs.eSimProfile.downloadFailed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.eSimProfile.downloaded": {
        "type": "object",
        "title": "com.gigs.eSimProfile.downloaded",
        "description": "Fires when the eSIM profile has been downloaded to a device, but not yet installed. Only available for providers `p11` and `p32`.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/eSimProfile"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.eSimProfile.downloaded",
            "description": "Type is always `com.gigs.eSimProfile.downloaded`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.eSimProfile.enabled": {
        "type": "object",
        "title": "com.gigs.eSimProfile.enabled",
        "description": "Fires when the eSIM profile is enabled. Only available for providers `p3`, `p11`, `p12`, `p14`, `p15` and `p18`.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/eSimProfile"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.eSimProfile.enabled",
            "description": "Type is always `com.gigs.eSimProfile.enabled`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.eSimProfile.installationFailed": {
        "type": "object",
        "title": "com.gigs.eSimProfile.installationFailed",
        "description": "Fires when the eSIM profile fails to install on a device. Only available for selected providers.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/eSimProfile"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.eSimProfile.installationFailed",
            "description": "Type is always `com.gigs.eSimProfile.installationFailed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.eSimProfile.installed": {
        "type": "object",
        "title": "com.gigs.eSimProfile.installed",
        "description": "Fires when the eSIM profile is installed on a device. Only available for providers `p3`, `p11`, `p12`, `p14`, `p15` and `p18`.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/eSimProfile"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.eSimProfile.installed",
            "description": "Type is always `com.gigs.eSimProfile.installed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.eSimProfile.updated": {
        "type": "object",
        "title": "com.gigs.eSimProfile.updated",
        "description": "Fires when the eSIM profile is updated. Only available for providers `p3`, `p11`, `p14`, `p15` and `p18`.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/eSimProfile"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.eSimProfile.updated",
            "description": "Type is always `com.gigs.eSimProfile.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.installation.created": {
        "type": "object",
        "title": "com.gigs.installation.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Installation",
            "properties": {
              "object": {
                "type": "string",
                "const": "installation",
                "description": "Type of object is always `installation`."
              },
              "application": {
                "type": "string",
                "enum": [
                  "gigs-access",
                  "gigs-connect",
                  "gigs-emails",
                  "gigs-for-work",
                  "gigs-support",
                  "gigs-uk-regulatory-smses"
                ],
                "description": "Name of the installation application.",
                "examples": [
                  "gigs-connect"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "description": "Time when the installation was created.",
                "examples": [
                  "2022-01-21T19:38:34Z"
                ]
              },
              "settings": {
                "type": "object",
                "description": "Object containing installation settings.",
                "additionalProperties": true
              }
            },
            "required": [
              "object",
              "application",
              "settings",
              "createdAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.installation.created",
            "description": "Type is always `com.gigs.installation.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.installation.updated": {
        "type": "object",
        "title": "com.gigs.installation.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Installation",
            "properties": {
              "object": {
                "type": "string",
                "const": "installation",
                "description": "Type of object is always `installation`."
              },
              "application": {
                "type": "string",
                "enum": [
                  "gigs-access",
                  "gigs-connect",
                  "gigs-emails",
                  "gigs-for-work",
                  "gigs-support",
                  "gigs-uk-regulatory-smses"
                ],
                "description": "Name of the installation application.",
                "examples": [
                  "gigs-connect"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "description": "Time when the installation was created.",
                "examples": [
                  "2022-01-21T19:38:34Z"
                ]
              },
              "settings": {
                "type": "object",
                "description": "Object containing installation settings.",
                "additionalProperties": true
              }
            },
            "required": [
              "object",
              "application",
              "settings",
              "createdAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.installation.updated",
            "description": "Type is always `com.gigs.installation.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.invoice.created": {
        "type": "object",
        "title": "com.gigs.invoice.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/invoice"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.invoice.created",
            "description": "Type is always `com.gigs.invoice.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.invoice.finalized": {
        "type": "object",
        "title": "com.gigs.invoice.finalized",
        "description": "Triggered when an invoice is finalized and becomes due for payment.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/invoice"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.invoice.finalized",
            "description": "Type is always `com.gigs.invoice.finalized`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.invoice.overdue": {
        "type": "object",
        "title": "com.gigs.invoice.overdue",
        "description": "Triggered when an invoice becomes overdue and the overdue period starts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/invoice"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.invoice.overdue",
            "description": "Type is always `com.gigs.invoice.overdue`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.invoice.paid": {
        "type": "object",
        "title": "com.gigs.invoice.paid",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/invoice"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.invoice.paid",
            "description": "Type is always `com.gigs.invoice.paid`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.invoice.updated": {
        "type": "object",
        "title": "com.gigs.invoice.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/invoice"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.invoice.updated",
            "description": "Type is always `com.gigs.invoice.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.invoice.voided": {
        "type": "object",
        "title": "com.gigs.invoice.voided",
        "description": "Triggered when an invoice is voided and can no longer be paid.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/invoice"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.invoice.voided",
            "description": "Type is always `com.gigs.invoice.voided`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.invoice.willBeOverdue": {
        "type": "object",
        "title": "com.gigs.invoice.willBeOverdue",
        "description": "Triggered 24 hours before the overdue period starts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/invoice"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.invoice.willBeOverdue",
            "description": "Type is always `com.gigs.invoice.willBeOverdue`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.created": {
        "type": "object",
        "title": "com.gigs.payment.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.created",
            "description": "Type is always `com.gigs.payment.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.disputeLost": {
        "type": "object",
        "title": "com.gigs.payment.disputeLost",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.disputeLost",
            "description": "Type is always `com.gigs.payment.disputeLost`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.disputeWon": {
        "type": "object",
        "title": "com.gigs.payment.disputeWon",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.disputeWon",
            "description": "Type is always `com.gigs.payment.disputeWon`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.disputed": {
        "type": "object",
        "title": "com.gigs.payment.disputed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.disputed",
            "description": "Type is always `com.gigs.payment.disputed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.failed": {
        "type": "object",
        "title": "com.gigs.payment.failed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.failed",
            "description": "Type is always `com.gigs.payment.failed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.paymentMethod.confirmed": {
        "type": "object",
        "title": "com.gigs.paymentMethod.confirmed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/paymentMethod"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.paymentMethod.confirmed",
            "description": "Type is always `com.gigs.paymentMethod.confirmed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.paymentMethod.created": {
        "type": "object",
        "title": "com.gigs.paymentMethod.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/paymentMethod"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.paymentMethod.created",
            "description": "Type is always `com.gigs.paymentMethod.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.paymentMethod.deleted": {
        "type": "object",
        "title": "com.gigs.paymentMethod.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/paymentMethod"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.paymentMethod.deleted",
            "description": "Type is always `com.gigs.paymentMethod.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.paymentMethodRequired": {
        "type": "object",
        "title": "com.gigs.payment.paymentMethodRequired",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.paymentMethodRequired",
            "description": "Type is always `com.gigs.payment.paymentMethodRequired`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.refunded": {
        "type": "object",
        "title": "com.gigs.payment.refunded",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.refunded",
            "description": "Type is always `com.gigs.payment.refunded`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.requiresConfirmation": {
        "type": "object",
        "title": "com.gigs.payment.requiresConfirmation",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.requiresConfirmation",
            "description": "Type is always `com.gigs.payment.requiresConfirmation`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.payment.succeeded": {
        "type": "object",
        "title": "com.gigs.payment.succeeded",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/payment"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.payment.succeeded",
            "description": "Type is always `com.gigs.payment.succeeded`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.plan.archived": {
        "type": "object",
        "title": "com.gigs.plan.archived",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/plan"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.plan.archived",
            "description": "Type is always `com.gigs.plan.archived`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.plan.created": {
        "type": "object",
        "title": "com.gigs.plan.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/plan"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.plan.created",
            "description": "Type is always `com.gigs.plan.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.plan.deleted": {
        "type": "object",
        "title": "com.gigs.plan.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/plan"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.plan.deleted",
            "description": "Type is always `com.gigs.plan.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.plan.published": {
        "type": "object",
        "title": "com.gigs.plan.published",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/plan"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.plan.published",
            "description": "Type is always `com.gigs.plan.published`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.plan.updated": {
        "type": "object",
        "title": "com.gigs.plan.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/plan"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.plan.updated",
            "description": "Type is always `com.gigs.plan.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.portOut.completed": {
        "type": "object",
        "title": "com.gigs.portOut.completed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/portOut"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.portOut.completed",
            "description": "Type is always `com.gigs.portOut.completed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.portOut.created": {
        "type": "object",
        "title": "com.gigs.portOut.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/portOut"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.portOut.created",
            "description": "Type is always `com.gigs.portOut.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.portOutCredentials.issued": {
        "type": "object",
        "title": "com.gigs.portOutCredentials.issued",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/deprecatedPortOutCredential"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.portOutCredentials.issued",
            "description": "Type is always `com.gigs.portOutCredentials.issued`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": true
      },
      "com.gigs.portOut.expired": {
        "type": "object",
        "title": "com.gigs.portOut.expired",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/portOut"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.portOut.expired",
            "description": "Type is always `com.gigs.portOut.expired`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.portOut.failed": {
        "type": "object",
        "title": "com.gigs.portOut.failed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/portOut"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.portOut.failed",
            "description": "Type is always `com.gigs.portOut.failed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.portOut.issued": {
        "type": "object",
        "title": "com.gigs.portOut.issued",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/portOut"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.portOut.issued",
            "description": "Type is always `com.gigs.portOut.issued`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.portOut.processing": {
        "type": "object",
        "title": "com.gigs.portOut.processing",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/portOut"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.portOut.processing",
            "description": "Type is always `com.gigs.portOut.processing`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.portOut.updated": {
        "type": "object",
        "title": "com.gigs.portOut.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/portOut"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.portOut.updated",
            "description": "Type is always `com.gigs.portOut.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.canceled": {
        "type": "object",
        "title": "com.gigs.porting.canceled",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.canceled",
            "description": "Type is always `com.gigs.porting.canceled`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.completed": {
        "type": "object",
        "title": "com.gigs.porting.completed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.completed",
            "description": "Type is always `com.gigs.porting.completed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.created": {
        "type": "object",
        "title": "com.gigs.porting.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.created",
            "description": "Type is always `com.gigs.porting.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.declined": {
        "type": "object",
        "title": "com.gigs.porting.declined",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.declined",
            "description": "Type is always `com.gigs.porting.declined`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.deleted": {
        "type": "object",
        "title": "com.gigs.porting.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.deleted",
            "description": "Type is always `com.gigs.porting.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.expired": {
        "type": "object",
        "title": "com.gigs.porting.expired",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.expired",
            "description": "Type is always `com.gigs.porting.expired`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.failed": {
        "type": "object",
        "title": "com.gigs.porting.failed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.failed",
            "description": "Type is always `com.gigs.porting.failed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.informationRequired": {
        "type": "object",
        "title": "com.gigs.porting.informationRequired",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.informationRequired",
            "description": "Type is always `com.gigs.porting.informationRequired`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.requested": {
        "type": "object",
        "title": "com.gigs.porting.requested",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.requested",
            "description": "Type is always `com.gigs.porting.requested`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.porting.updated": {
        "type": "object",
        "title": "com.gigs.porting.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/porting"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.porting.updated",
            "description": "Type is always `com.gigs.porting.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.project.created": {
        "type": "object",
        "title": "com.gigs.project.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/project"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.project.created",
            "description": "Type is always `com.gigs.project.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.project.deleted": {
        "type": "object",
        "title": "com.gigs.project.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/project"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.project.deleted",
            "description": "Type is always `com.gigs.project.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.project.restored": {
        "type": "object",
        "title": "com.gigs.project.restored",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/project"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.project.restored",
            "description": "Type is always `com.gigs.project.restored`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.project.updated": {
        "type": "object",
        "title": "com.gigs.project.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/project"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.project.updated",
            "description": "Type is always `com.gigs.project.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.quote.created": {
        "type": "object",
        "title": "com.gigs.quote.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/quote"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.quote.created",
            "description": "Type is always `com.gigs.quote.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.roaming.ended": {
        "type": "object",
        "title": "com.gigs.roaming.ended",
        "description": "Fires when a subscription stops roaming in the country it was last seen\nroaming in.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Roaming",
            "description": "A subscription using a mobile network outside the country in which its plan is provided.",
            "properties": {
              "object": {
                "type": "string",
                "const": "roaming",
                "description": "Type of object is always `roaming`."
              },
              "countries": {
                "type": "array",
                "description": "The countries in which the subscription may be roaming, as ISO 3166-1 alpha-2 codes.\nKosovo has no ISO 3166-1 assignment and is reported as `XK`.\n\nGenerally a single entry. Some mobile networks cover several overseas territories at\nonce, and report the whole group rather than one territory. In that case the\nlist holds every territory in the group, and the subscription is in exactly one\nof them.\n",
                "items": {
                  "type": "string",
                  "examples": [
                    "DE"
                  ]
                },
                "examples": [
                  [
                    "DE"
                  ]
                ]
              },
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the roaming subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "startedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Time the subscription started roaming in `countries`.",
                "examples": [
                  "2021-02-14T00:00:00Z"
                ]
              },
              "endedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Time the subscription stopped roaming in `countries`.",
                "examples": [
                  "2021-02-14T00:00:00Z"
                ]
              }
            },
            "required": [
              "object",
              "subscription",
              "countries",
              "startedAt",
              "endedAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.roaming.ended",
            "description": "Type is always `com.gigs.roaming.ended`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.roaming.started": {
        "type": "object",
        "title": "com.gigs.roaming.started",
        "description": "Fires when a subscription is seen on a network in a country it was not\nalready roaming in.\n\nConsecutive connections to a network in the same country do not fire a\nnew event.\n\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Roaming",
            "description": "A subscription using a mobile network outside the country in which its plan is provided.",
            "properties": {
              "object": {
                "type": "string",
                "const": "roaming",
                "description": "Type of object is always `roaming`."
              },
              "countries": {
                "type": "array",
                "description": "The countries in which the subscription may be roaming, as ISO 3166-1 alpha-2 codes.\nKosovo has no ISO 3166-1 assignment and is reported as `XK`.\n\nGenerally a single entry. Some mobile networks cover several overseas territories at\nonce, and report the whole group rather than one territory. In that case the\nlist holds every territory in the group, and the subscription is in exactly one\nof them.\n",
                "items": {
                  "type": "string",
                  "examples": [
                    "DE"
                  ]
                },
                "examples": [
                  [
                    "DE"
                  ]
                ]
              },
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the roaming subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "startedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Time the subscription started roaming in `countries`.",
                "examples": [
                  "2021-02-14T00:00:00Z"
                ]
              },
              "endedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Time the subscription stopped roaming in `countries`.",
                "examples": [
                  "2021-02-14T00:00:00Z"
                ]
              }
            },
            "required": [
              "object",
              "subscription",
              "countries",
              "startedAt",
              "endedAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.roaming.started",
            "description": "Type is always `com.gigs.roaming.started`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.sim.activated": {
        "type": "object",
        "title": "com.gigs.sim.activated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/sim"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.sim.activated",
            "description": "Type is always `com.gigs.sim.activated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.sim.created": {
        "type": "object",
        "title": "com.gigs.sim.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/sim"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.sim.created",
            "description": "Type is always `com.gigs.sim.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.sim.deactivated": {
        "type": "object",
        "title": "com.gigs.sim.deactivated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/sim"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.sim.deactivated",
            "description": "Type is always `com.gigs.sim.deactivated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.sim.deleted": {
        "type": "object",
        "title": "com.gigs.sim.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/sim"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.sim.deleted",
            "description": "Type is always `com.gigs.sim.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.sim.retired": {
        "type": "object",
        "title": "com.gigs.sim.retired",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/sim"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.sim.retired",
            "description": "Type is always `com.gigs.sim.retired`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.sim.suspended": {
        "type": "object",
        "title": "com.gigs.sim.suspended",
        "description": "Triggered when the network provider confirms a SIM's suspension. A suspended SIM has no voice, SMS or data.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/sim"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.sim.suspended",
            "description": "Type is always `com.gigs.sim.suspended`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.sim.unsuspended": {
        "type": "object",
        "title": "com.gigs.sim.unsuspended",
        "description": "Triggered when the network provider confirms that a SIM is unsuspended, restoring voice, SMS and data.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/sim"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.sim.unsuspended",
            "description": "Type is always `com.gigs.sim.unsuspended`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.sim.updated": {
        "type": "object",
        "title": "com.gigs.sim.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/sim"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.sim.updated",
            "description": "Type is always `com.gigs.sim.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.activated": {
        "type": "object",
        "title": "com.gigs.subscription.activated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.activated",
            "description": "Type is always `com.gigs.subscription.activated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionAddon.activated": {
        "type": "object",
        "title": "com.gigs.subscriptionAddon.activated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionAddon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionAddon.activated",
            "description": "Type is always `com.gigs.subscriptionAddon.activated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionAddon.created": {
        "type": "object",
        "title": "com.gigs.subscriptionAddon.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionAddon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionAddon.created",
            "description": "Type is always `com.gigs.subscriptionAddon.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionAddon.ended": {
        "type": "object",
        "title": "com.gigs.subscriptionAddon.ended",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionAddon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionAddon.ended",
            "description": "Type is always `com.gigs.subscriptionAddon.ended`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionAddon.resumed": {
        "type": "object",
        "title": "com.gigs.subscriptionAddon.resumed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionAddon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionAddon.resumed",
            "description": "Type is always `com.gigs.subscriptionAddon.resumed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionAddon.updated": {
        "type": "object",
        "title": "com.gigs.subscriptionAddon.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionAddon"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionAddon.updated",
            "description": "Type is always `com.gigs.subscriptionAddon.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.canceled": {
        "type": "object",
        "title": "com.gigs.subscription.canceled",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.canceled",
            "description": "Type is always `com.gigs.subscription.canceled`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionChange.applied": {
        "type": "object",
        "title": "com.gigs.subscriptionChange.applied",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionChange"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionChange.applied",
            "description": "Type is always `com.gigs.subscriptionChange.applied`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionChange.created": {
        "type": "object",
        "title": "com.gigs.subscriptionChange.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionChange"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionChange.created",
            "description": "Type is always `com.gigs.subscriptionChange.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionChange.deleted": {
        "type": "object",
        "title": "com.gigs.subscriptionChange.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionChange"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionChange.deleted",
            "description": "Type is always `com.gigs.subscriptionChange.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionChange.failed": {
        "type": "object",
        "title": "com.gigs.subscriptionChange.failed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionChange"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionChange.failed",
            "description": "Type is always `com.gigs.subscriptionChange.failed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionChange.pending": {
        "type": "object",
        "title": "com.gigs.subscriptionChange.pending",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionChange"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionChange.pending",
            "description": "Type is always `com.gigs.subscriptionChange.pending`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionChange.updated": {
        "type": "object",
        "title": "com.gigs.subscriptionChange.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionChange"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionChange.updated",
            "description": "Type is always `com.gigs.subscriptionChange.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.created": {
        "type": "object",
        "title": "com.gigs.subscription.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.created",
            "description": "Type is always `com.gigs.subscription.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.ended": {
        "type": "object",
        "title": "com.gigs.subscription.ended",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.ended",
            "description": "Type is always `com.gigs.subscription.ended`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionGroup.created": {
        "type": "object",
        "title": "com.gigs.subscriptionGroup.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionGroup"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionGroup.created",
            "description": "Type is always `com.gigs.subscriptionGroup.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionGroup.deleted": {
        "type": "object",
        "title": "com.gigs.subscriptionGroup.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionGroup"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionGroup.deleted",
            "description": "Type is always `com.gigs.subscriptionGroup.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscriptionGroup.updated": {
        "type": "object",
        "title": "com.gigs.subscriptionGroup.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscriptionGroup"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscriptionGroup.updated",
            "description": "Type is always `com.gigs.subscriptionGroup.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.renewed": {
        "type": "object",
        "title": "com.gigs.subscription.renewed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.renewed",
            "description": "Type is always `com.gigs.subscription.renewed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.restored": {
        "type": "object",
        "title": "com.gigs.subscription.restored",
        "description": "Triggered when a subscription is restored after being previously restricted (for example, after paying an overdue invoice).",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.restored",
            "description": "Type is always `com.gigs.subscription.restored`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.restricted": {
        "type": "object",
        "title": "com.gigs.subscription.restricted",
        "description": "Triggered when a subscription is restricted due to, for example, an overdue invoice.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.restricted",
            "description": "Type is always `com.gigs.subscription.restricted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.resumed": {
        "type": "object",
        "title": "com.gigs.subscription.resumed",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.resumed",
            "description": "Type is always `com.gigs.subscription.resumed`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.subscription.updated": {
        "type": "object",
        "title": "com.gigs.subscription.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/subscription"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.subscription.updated",
            "description": "Type is always `com.gigs.subscription.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.usageBalance.thresholdReached": {
        "type": "object",
        "title": "com.gigs.usageBalance.thresholdReached",
        "description": "Fires when usage reaches one of the predefined thresholds: 50%, 70%, 90%, or 100%.\nIf several thresholds are reached at the same time, the event fires only for the highest one.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/usageBalance"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.usageBalance.thresholdReached",
            "description": "Type is always `com.gigs.usageBalance.thresholdReached`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.usageNotification.created": {
        "type": "object",
        "title": "com.gigs.usageNotification.created",
        "description": "Triggered when a new usage notification is created.\n\nThe currently-supported types of usage notification are:\n\n  - `started`, which is fired when the `subscription` is first used.\n  - `throttled`, which is fired when the `subscription` has had its data\n    usage throttled to a lower bandwidth.\n  - `thresholdExceeded`, which is fired when the `subscription` has used\n    70%, 90% and 100% of its `data`, `sms` or `voice` allowance.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "UsageNotification",
            "properties": {
              "object": {
                "type": "string",
                "const": "usageNotification",
                "description": "Type of object is always `usageNotification`."
              },
              "subscription": {
                "type": "string",
                "description": "Unique subscription identifier.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "thresholdExceeded": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "Information about the exceeded threshold. Only present when `type` is\n`thresholdExceeded`.\n\nCurrently this notification is fired when a subscription has exceeded\neither 70%, 90% or 100% of its data, sms or voice allowances.\n",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "data",
                      "sms",
                      "voice",
                      "dataTethering",
                      "dataDevice",
                      "smsInternational",
                      "smsLocal",
                      "voiceInternational",
                      "voiceLocal"
                    ],
                    "description": "The usage type for the exceeded threshold.",
                    "examples": [
                      "data"
                    ]
                  },
                  "at": {
                    "type": "string",
                    "format": "date-time",
                    "description": "The time at which the threshold was exceeded.",
                    "examples": [
                      "2024-02-29T14:01:12Z"
                    ]
                  },
                  "data": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Data usage & allowance. Only present when `type` is `data`.",
                    "properties": {
                      "allowanceBytes": {
                        "type": "integer",
                        "description": "The total data allowance for the current subscription period, in\nbytes. This can be higher than the plan's data allowance if there\nare active subscription add-ons.\n",
                        "examples": [
                          10000000000
                        ]
                      },
                      "usageBytes": {
                        "type": "integer",
                        "description": "The total data usage for the current subscription period, in bytes.\n",
                        "examples": [
                          7000000000
                        ]
                      }
                    },
                    "required": [
                      "allowanceBytes",
                      "usageBytes"
                    ]
                  },
                  "percentage": {
                    "type": "integer",
                    "description": "The usage threshold percentage which was exceeded.",
                    "maximum": 100,
                    "minimum": 0,
                    "examples": [
                      70
                    ]
                  },
                  "roaming": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "none",
                      "international",
                      "domestic"
                    ],
                    "description": "Indicates the roaming mode for the usage in question.",
                    "examples": [
                      "none"
                    ]
                  },
                  "dataDevice": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Data allowance and its usage on device.",
                    "properties": {
                      "allowanceBytes": {
                        "type": "integer",
                        "description": "The total data allowance to be used on device, in bytes.",
                        "examples": [
                          5000000000
                        ]
                      },
                      "usageBytes": {
                        "type": "integer",
                        "description": "The total data usage on the device, in bytes.",
                        "examples": [
                          3500000000
                        ]
                      }
                    }
                  },
                  "dataTethering": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Data allowance and its usage for hotspot tethering.",
                    "properties": {
                      "allowanceBytes": {
                        "type": "integer",
                        "description": "The total data allowance for hotspot tethering mode, in bytes.",
                        "examples": [
                          5000000000
                        ]
                      },
                      "usageBytes": {
                        "type": "integer",
                        "description": "The total data usage for the current subscription period for tethering, in bytes.",
                        "examples": [
                          3500000000
                        ]
                      }
                    }
                  },
                  "voiceInternational": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Voice allowance and its usage for international calls.",
                    "properties": {
                      "allowanceSeconds": {
                        "type": "integer",
                        "description": "The total voice allowance for international calls, in seconds.",
                        "examples": [
                          10000
                        ]
                      },
                      "usageSeconds": {
                        "type": "integer",
                        "description": "The total voice usage for international calls, in seconds.",
                        "examples": [
                          7000
                        ]
                      }
                    }
                  },
                  "voiceLocal": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Voice allowance and its usage for local calls.",
                    "properties": {
                      "allowanceSeconds": {
                        "type": "integer",
                        "description": "The total voice allowance for local calls, in seconds.",
                        "examples": [
                          20000
                        ]
                      },
                      "usageSeconds": {
                        "type": "integer",
                        "description": "The total voice usage for local calls, in seconds.",
                        "examples": [
                          15000
                        ]
                      }
                    }
                  },
                  "smsInternational": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "SMS allowance and its usage for international messages.",
                    "properties": {
                      "allowanceMessages": {
                        "type": "integer",
                        "description": "The total sms allowance for international messages, in number of messages.",
                        "examples": [
                          5000
                        ]
                      },
                      "usageMessages": {
                        "type": "integer",
                        "description": "The total sms usage for international messages, in number of messages.",
                        "examples": [
                          3500
                        ]
                      }
                    }
                  },
                  "smsLocal": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "SMS allowance and its usage for local messages.",
                    "properties": {
                      "allowanceMessages": {
                        "type": "integer",
                        "description": "The total sms allowance for local messages, in number of messages.",
                        "examples": [
                          10000
                        ]
                      },
                      "usageMessages": {
                        "type": "integer",
                        "description": "The total sms usage for local messages, in number of messages.",
                        "examples": [
                          7000
                        ]
                      }
                    }
                  },
                  "sms": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Text usage & allowance. Only present when `type` is `sms`.",
                    "properties": {
                      "allowanceMessages": {
                        "type": "integer",
                        "description": "The total sms allowance for the current subscription period, in\nnumber of messages.\n",
                        "examples": [
                          10000
                        ]
                      },
                      "usageMessages": {
                        "type": "integer",
                        "description": "The total sms usage for the current subscription period, in number\nof messages.\n",
                        "examples": [
                          7000
                        ]
                      }
                    },
                    "required": [
                      "allowanceMessages",
                      "usageMessages"
                    ]
                  },
                  "subscriptionAddons": {
                    "type": "array",
                    "description": "List of identifiers of any subscription add-ons which contributed to\nthe crossed allowance threshold.\n",
                    "items": {
                      "type": "string"
                    },
                    "examples": [
                      [
                        "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                      ]
                    ]
                  },
                  "voice": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "description": "Voice usage & allowance. Only present when `type` is `voice`.",
                    "properties": {
                      "allowanceSeconds": {
                        "type": "integer",
                        "description": "The total voice allowance for the current subscription period, in\nseconds.\n",
                        "examples": [
                          50000
                        ]
                      },
                      "usageSeconds": {
                        "type": "integer",
                        "description": "The total voice usage for the current subscription period, in\nseconds.\n",
                        "examples": [
                          35000
                        ]
                      }
                    },
                    "required": [
                      "allowanceSeconds",
                      "usageSeconds"
                    ]
                  }
                },
                "required": [
                  "at",
                  "percentage",
                  "subscriptionAddons"
                ]
              },
              "throttled": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "The throttling configuration for the subscription. Only present if `type` is `throttled`.",
                "properties": {
                  "thresholdBytes": {
                    "type": "integer",
                    "description": "The threshold in bytes at which throttling will be applied.",
                    "examples": [
                      10000000000
                    ]
                  },
                  "bandwidthBitsPerSecond": {
                    "type": "integer",
                    "description": "The bandwidth in bits per second that the plan will be throttled to.",
                    "examples": [
                      512000
                    ]
                  },
                  "until": {
                    "type": "string",
                    "format": "date-time",
                    "description": "The time until which the throttling configuration is effective. Valid only at the time of publishing. Throttling may end earlier if a top-up is applied, allowing data usage to continue without throttling restrictions.",
                    "examples": [
                      "2021-02-20T19:38:34Z"
                    ]
                  }
                },
                "required": [
                  "thresholdBytes",
                  "bandwidthBitsPerSecond",
                  "until"
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "started",
                  "thresholdExceeded",
                  "throttled"
                ],
                "description": "The type of notification.",
                "examples": [
                  "throttled"
                ]
              }
            },
            "required": [
              "object",
              "subscription",
              "type"
            ],
            "examples": [
              {
                "object": "usageNotification",
                "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
                "thresholdExceeded": null,
                "throttled": {
                  "thresholdBytes": 10000000000,
                  "bandwidthBitsPerSecond": 512000,
                  "until": "2021-02-20T19:38:34Z"
                },
                "type": "throttled"
              }
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.usageNotification.created",
            "description": "Type is always `com.gigs.usageNotification.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.usageThreshold.exceeded": {
        "type": "object",
        "title": "com.gigs.usageThreshold.exceeded",
        "description": "<!-- theme: warning -->\n> #### Deprecated\n>\n> This event is deprecated and will be removed in the future.\n> Please use `com.gigs.usageNotification.created` instead. That event fires\n> with type `thresholdExceeded` at the same time as this one.\n\n\nFires whenever a data, sms or voice usage threshold is exceeded. The\ncurrently-supported thresholds are 70%, 90% and 100%.",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "UsageThresholdExceeded",
            "properties": {
              "object": {
                "type": "string",
                "const": "usageThresholdExceeded",
                "description": "Type of object is always `usageThresholdExceeded`."
              },
              "allowance": {
                "type": "integer",
                "description": "Indicates the absolute usage allowance in the subscription period. The value is in units specified by the `unit` field.",
                "examples": [
                  10000000000
                ]
              },
              "plan": {
                "type": "string",
                "description": "Unique plan identifier for the plan that provided the allowance.",
                "examples": [
                  "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
                ]
              },
              "project": {
                "type": "string",
                "description": "Unique project identifier.",
                "examples": [
                  "test"
                ]
              },
              "subscription": {
                "type": "string",
                "description": "Unique subscription identifier.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "subscriptionAddons": {
                "type": [
                  "array",
                  "null"
                ],
                "description": "List of unique subscription add-on identifiers for add-ons that contributed to the allowance.",
                "items": {
                  "type": "string"
                },
                "examples": [
                  [
                    "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
                  ]
                ]
              },
              "thresholdPercentage": {
                "type": "integer",
                "description": "Indicates the usage threshold percentage which was exceeded.",
                "maximum": 100,
                "minimum": 0,
                "examples": [
                  75
                ]
              },
              "type": {
                "type": "string",
                "enum": [
                  "data",
                  "voice",
                  "sms"
                ],
                "description": "The usage type for the exceeded threshold.",
                "examples": [
                  "data"
                ]
              },
              "unit": {
                "type": "string",
                "enum": [
                  "bytes",
                  "seconds",
                  "messages"
                ],
                "description": "The unit of the usage and allowance values.",
                "examples": [
                  "bytes"
                ]
              },
              "usage": {
                "type": "integer",
                "description": "Indicates the absolute usage amount in the subscription period, at the time the threshold was exceeded. The value is in units specified by the `unit` field.",
                "minimum": 0,
                "examples": [
                  7500000000
                ]
              },
              "usageAt": {
                "type": "string",
                "format": "date-time",
                "description": "Time associated to the usage that exceeded the threshold.",
                "examples": [
                  "2021-01-21T19:38:34Z"
                ]
              }
            },
            "required": [
              "object",
              "allowance",
              "plan",
              "project",
              "subscription",
              "subscriptionAddons",
              "thresholdPercentage",
              "type",
              "unit",
              "usage",
              "usageAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.usageThreshold.exceeded",
            "description": "Type is always `com.gigs.usageThreshold.exceeded`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": true
      },
      "com.gigs.user.address.created": {
        "type": "object",
        "title": "com.gigs.user.address.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/userAddress"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.user.address.created",
            "description": "Type is always `com.gigs.user.address.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.user.address.deleted": {
        "type": "object",
        "title": "com.gigs.user.address.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/userAddress"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.user.address.deleted",
            "description": "Type is always `com.gigs.user.address.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.user.blocked": {
        "type": "object",
        "title": "com.gigs.user.blocked",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/user"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.user.blocked",
            "description": "Type is always `com.gigs.user.blocked`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.user.created": {
        "type": "object",
        "title": "com.gigs.user.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/user"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.user.created",
            "description": "Type is always `com.gigs.user.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.user.deleted": {
        "type": "object",
        "title": "com.gigs.user.deleted",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/user"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.user.deleted",
            "description": "Type is always `com.gigs.user.deleted`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.user.updated": {
        "type": "object",
        "title": "com.gigs.user.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/user"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.user.updated",
            "description": "Type is always `com.gigs.user.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.user.verified": {
        "type": "object",
        "title": "com.gigs.user.verified",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/user"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.user.verified",
            "description": "Type is always `com.gigs.user.verified`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.virtualNumber.activated": {
        "type": "object",
        "title": "com.gigs.virtualNumber.activated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/virtualNumber"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.virtualNumber.activated",
            "description": "Type is always `com.gigs.virtualNumber.activated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.virtualNumber.canceled": {
        "type": "object",
        "title": "com.gigs.virtualNumber.canceled",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/virtualNumber"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.virtualNumber.canceled",
            "description": "Type is always `com.gigs.virtualNumber.canceled`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.virtualNumber.created": {
        "type": "object",
        "title": "com.gigs.virtualNumber.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/virtualNumber"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.virtualNumber.created",
            "description": "Type is always `com.gigs.virtualNumber.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.virtualNumber.ended": {
        "type": "object",
        "title": "com.gigs.virtualNumber.ended",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/virtualNumber"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.virtualNumber.ended",
            "description": "Type is always `com.gigs.virtualNumber.ended`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.virtualNumber.updated": {
        "type": "object",
        "title": "com.gigs.virtualNumber.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/virtualNumber"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.virtualNumber.updated",
            "description": "Type is always `com.gigs.virtualNumber.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.voucher.created": {
        "type": "object",
        "title": "com.gigs.voucher.created",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/voucher"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.voucher.created",
            "description": "Type is always `com.gigs.voucher.created`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.voucher.retired": {
        "type": "object",
        "title": "com.gigs.voucher.retired",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/voucher"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.voucher.retired",
            "description": "Type is always `com.gigs.voucher.retired`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.voucher.updated": {
        "type": "object",
        "title": "com.gigs.voucher.updated",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "$ref": "#/components/schemas/voucher"
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "previousData": {
            "type": "object",
            "description": "Present only for events of type `*.updated`. Contains the values fields in\nthe schema had prior to the update.\n\nThis field is the result of a shallow diff of the previous schema (i.e., if\na nested field has changed, then the entire object will be included).\n",
            "additionalProperties": true
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.voucher.updated",
            "description": "Type is always `com.gigs.voucher.updated`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.reminder.porting.declined": {
        "type": "object",
        "title": "com.gigs.reminder.porting.declined",
        "description": "Fired when a porting request has been declined and the user needs to correct the provided information and resubmit.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Reminder",
            "description": "Reminders help to onboard users and are triggered by time-based thresholds.",
            "properties": {
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "conditionTriggeredAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the condition that triggered this reminder occurred (e.g. porting status changed to informationRequired).",
                "examples": [
                  "2025-01-21T19:38:34Z"
                ]
              },
              "number": {
                "type": "integer",
                "description": "Number of times this reminder has been sent for the subscription.",
                "examples": [
                  1
                ]
              },
              "nextReminderAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Timestamp when the next reminder is scheduled to be sent, or null if this is the last reminder.",
                "examples": [
                  "2025-01-22T19:38:34Z"
                ]
              }
            },
            "required": [
              "subscription",
              "conditionTriggeredAt",
              "number",
              "nextReminderAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.reminder.porting.declined",
            "description": "Type is always `com.gigs.reminder.porting.declined`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.reminder.porting.informationRequired": {
        "type": "object",
        "title": "com.gigs.reminder.porting.informationRequired",
        "description": "Fired when a porting request requires additional information from the user, or, for a porting with a manual request behavior, is waiting for the user to confirm it before it is requested.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Reminder",
            "description": "Reminders help to onboard users and are triggered by time-based thresholds.",
            "properties": {
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "conditionTriggeredAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the condition that triggered this reminder occurred (e.g. porting status changed to informationRequired).",
                "examples": [
                  "2025-01-21T19:38:34Z"
                ]
              },
              "number": {
                "type": "integer",
                "description": "Number of times this reminder has been sent for the subscription.",
                "examples": [
                  1
                ]
              },
              "nextReminderAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Timestamp when the next reminder is scheduled to be sent, or null if this is the last reminder.",
                "examples": [
                  "2025-01-22T19:38:34Z"
                ]
              }
            },
            "required": [
              "subscription",
              "conditionTriggeredAt",
              "number",
              "nextReminderAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.reminder.porting.informationRequired",
            "description": "Type is always `com.gigs.reminder.porting.informationRequired`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.reminder.porting.requested": {
        "type": "object",
        "title": "com.gigs.reminder.porting.requested",
        "description": "Fired when a porting is in requested state for a prolonged period so the user can check status with porting's donor provider.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Reminder",
            "description": "Reminders help to onboard users and are triggered by time-based thresholds.",
            "properties": {
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "conditionTriggeredAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the condition that triggered this reminder occurred (e.g. porting status changed to informationRequired).",
                "examples": [
                  "2025-01-21T19:38:34Z"
                ]
              },
              "number": {
                "type": "integer",
                "description": "Number of times this reminder has been sent for the subscription.",
                "examples": [
                  1
                ]
              },
              "nextReminderAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Timestamp when the next reminder is scheduled to be sent, or null if this is the last reminder.",
                "examples": [
                  "2025-01-22T19:38:34Z"
                ]
              }
            },
            "required": [
              "subscription",
              "conditionTriggeredAt",
              "number",
              "nextReminderAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.reminder.porting.requested",
            "description": "Type is always `com.gigs.reminder.porting.requested`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.reminder.porting.scheduled": {
        "type": "object",
        "title": "com.gigs.reminder.porting.scheduled",
        "description": "Fired before a scheduled porting takes effect.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Reminder",
            "description": "Reminders help to onboard users and are triggered by time-based thresholds.",
            "properties": {
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "conditionTriggeredAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the condition that triggered this reminder occurred (e.g. porting status changed to informationRequired).",
                "examples": [
                  "2025-01-21T19:38:34Z"
                ]
              },
              "number": {
                "type": "integer",
                "description": "Number of times this reminder has been sent for the subscription.",
                "examples": [
                  1
                ]
              },
              "nextReminderAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Timestamp when the next reminder is scheduled to be sent, or null if this is the last reminder.",
                "examples": [
                  "2025-01-22T19:38:34Z"
                ]
              }
            },
            "required": [
              "subscription",
              "conditionTriggeredAt",
              "number",
              "nextReminderAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.reminder.porting.scheduled",
            "description": "Type is always `com.gigs.reminder.porting.scheduled`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.reminder.sim.suspended": {
        "type": "object",
        "title": "com.gigs.reminder.sim.suspended",
        "description": "Fired while a subscription's SIM stays suspended, 7, 14, 21, 28 and 29 days after the network provider confirmed the suspension. The subscription ends 30 days after that confirmation unless the SIM is unsuspended. `conditionTriggeredAt` is when the suspension was confirmed.\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Reminder",
            "description": "Reminders help to onboard users and are triggered by time-based thresholds.",
            "properties": {
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "conditionTriggeredAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the condition that triggered this reminder occurred (e.g. porting status changed to informationRequired).",
                "examples": [
                  "2025-01-21T19:38:34Z"
                ]
              },
              "number": {
                "type": "integer",
                "description": "Number of times this reminder has been sent for the subscription.",
                "examples": [
                  1
                ]
              },
              "nextReminderAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Timestamp when the next reminder is scheduled to be sent, or null if this is the last reminder.",
                "examples": [
                  "2025-01-22T19:38:34Z"
                ]
              }
            },
            "required": [
              "subscription",
              "conditionTriggeredAt",
              "number",
              "nextReminderAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.reminder.sim.suspended",
            "description": "Type is always `com.gigs.reminder.sim.suspended`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.reminder.subscription.pending": {
        "type": "object",
        "title": "com.gigs.reminder.subscription.pending",
        "description": "Fired when a subscription has remained in the pending status for an extended period (30 days).\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Reminder",
            "description": "Reminders help to onboard users and are triggered by time-based thresholds.",
            "properties": {
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "conditionTriggeredAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the condition that triggered this reminder occurred (e.g. porting status changed to informationRequired).",
                "examples": [
                  "2025-01-21T19:38:34Z"
                ]
              },
              "number": {
                "type": "integer",
                "description": "Number of times this reminder has been sent for the subscription.",
                "examples": [
                  1
                ]
              },
              "nextReminderAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Timestamp when the next reminder is scheduled to be sent, or null if this is the last reminder.",
                "examples": [
                  "2025-01-22T19:38:34Z"
                ]
              }
            },
            "required": [
              "subscription",
              "conditionTriggeredAt",
              "number",
              "nextReminderAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.reminder.subscription.pending",
            "description": "Type is always `com.gigs.reminder.subscription.pending`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.reminder.subscription.simNotInstalled": {
        "type": "object",
        "title": "com.gigs.reminder.subscription.simNotInstalled",
        "description": "Fired when an eSIM has been assigned but it is not yet installed on the user's device. Only available for providers that support eSIM lifecycle events (p3, p11, p14, p15).\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Reminder",
            "description": "Reminders help to onboard users and are triggered by time-based thresholds.",
            "properties": {
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "conditionTriggeredAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the condition that triggered this reminder occurred (e.g. porting status changed to informationRequired).",
                "examples": [
                  "2025-01-21T19:38:34Z"
                ]
              },
              "number": {
                "type": "integer",
                "description": "Number of times this reminder has been sent for the subscription.",
                "examples": [
                  1
                ]
              },
              "nextReminderAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Timestamp when the next reminder is scheduled to be sent, or null if this is the last reminder.",
                "examples": [
                  "2025-01-22T19:38:34Z"
                ]
              }
            },
            "required": [
              "subscription",
              "conditionTriggeredAt",
              "number",
              "nextReminderAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.reminder.subscription.simNotInstalled",
            "description": "Type is always `com.gigs.reminder.subscription.simNotInstalled`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      },
      "com.gigs.reminder.subscription.usageMissing": {
        "type": "object",
        "title": "com.gigs.reminder.subscription.usageMissing",
        "description": "Fired when an eSIM is installed but no usage has been detected after activation. Only available for providers that support eSIM lifecycle events (p3, p11, p14, p15).\n\n<!-- theme: info -->\n> #### Preview\n>\n> This event is currently in preview and might change in the future.\n>\n> We’re excited to hear your feedback and ideas. Please send an email\n> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.\n",
        "properties": {
          "object": {
            "type": "string",
            "const": "event",
            "description": "Type of object is always `event`."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the event.",
            "examples": [
              "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
            ]
          },
          "actor": {
            "$ref": "#/components/schemas/actor"
          },
          "data": {
            "type": "object",
            "title": "Reminder",
            "description": "Reminders help to onboard users and are triggered by time-based thresholds.",
            "properties": {
              "subscription": {
                "type": "string",
                "description": "Unique identifier for the subscription.",
                "examples": [
                  "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
                ]
              },
              "conditionTriggeredAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the condition that triggered this reminder occurred (e.g. porting status changed to informationRequired).",
                "examples": [
                  "2025-01-21T19:38:34Z"
                ]
              },
              "number": {
                "type": "integer",
                "description": "Number of times this reminder has been sent for the subscription.",
                "examples": [
                  1
                ]
              },
              "nextReminderAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "description": "Timestamp when the next reminder is scheduled to be sent, or null if this is the last reminder.",
                "examples": [
                  "2025-01-22T19:38:34Z"
                ]
              }
            },
            "required": [
              "subscription",
              "conditionTriggeredAt",
              "number",
              "nextReminderAt"
            ]
          },
          "datacontenttype": {
            "type": "string",
            "default": "application/json",
            "description": "The RFC 2046 content-type.",
            "examples": [
              "application/json"
            ]
          },
          "project": {
            "type": "string",
            "description": "Unique identifier for the project where the event occurred.",
            "examples": [
              "gigs"
            ]
          },
          "source": {
            "type": "string",
            "default": "https://api.gigs.com",
            "description": "URI identifying the event source.",
            "examples": [
              "https://api.gigs.com"
            ]
          },
          "specversion": {
            "type": "string",
            "default": "1.0",
            "description": "The CloudEvents spec version.",
            "examples": [
              "1.0"
            ]
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the event occurred.",
            "examples": [
              "2022-03-16T14:12:42Z"
            ]
          },
          "type": {
            "type": "string",
            "const": "com.gigs.reminder.subscription.usageMissing",
            "description": "Type is always `com.gigs.reminder.subscription.usageMissing`."
          },
          "version": {
            "type": "string",
            "description": "API version used to serialize the data and the event itself.",
            "examples": [
              "2026-01-29.42"
            ]
          }
        },
        "required": [
          "object",
          "id",
          "actor",
          "data",
          "datacontenttype",
          "project",
          "source",
          "specversion",
          "time",
          "type",
          "version"
        ],
        "deprecated": false
      }
    },
    "responses": {
      "badRequest": {
        "description": "The request has incorrect syntax, such as an unparseable JSON body.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            },
            "examples": {
              "Example - Full": {
                "summary": "Example - Full",
                "value": {
                  "object": "error",
                  "code": "unknown",
                  "details": [
                    {
                      "object": "propertyErrorDetail",
                      "code": "propertyRequired",
                      "message": "Invalid value for property.",
                      "property": "property1",
                      "suggestion": "alternative_value"
                    }
                  ],
                  "documentation": [
                    "https://developers.gigs.com/api/error-handling"
                  ],
                  "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              },
              "Example - Required": {
                "summary": "Example - Required",
                "value": {
                  "object": "error",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              }
            }
          }
        }
      },
      "notFound": {
        "description": "The requested resource doesn't exist.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            },
            "examples": {
              "Example - Full": {
                "summary": "Example - Full",
                "value": {
                  "object": "error",
                  "code": "unknown",
                  "details": [
                    {
                      "object": "propertyErrorDetail",
                      "code": "propertyRequired",
                      "message": "Invalid value for property.",
                      "property": "property1",
                      "suggestion": "alternative_value"
                    }
                  ],
                  "documentation": [
                    "https://developers.gigs.com/api/error-handling"
                  ],
                  "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              },
              "Example - Required": {
                "summary": "Example - Required",
                "value": {
                  "object": "error",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              }
            }
          }
        }
      },
      "permissionDenied": {
        "description": "The authenticated user doesn't have permissions to perform the request.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            },
            "examples": {
              "Example - Full": {
                "summary": "Example - Full",
                "value": {
                  "object": "error",
                  "code": "unknown",
                  "details": [
                    {
                      "object": "propertyErrorDetail",
                      "code": "propertyRequired",
                      "message": "Invalid value for property.",
                      "property": "property1",
                      "suggestion": "alternative_value"
                    }
                  ],
                  "documentation": [
                    "https://developers.gigs.com/api/error-handling"
                  ],
                  "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              },
              "Example - Required": {
                "summary": "Example - Required",
                "value": {
                  "object": "error",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              }
            }
          }
        }
      },
      "conflict": {
        "description": "The request conflicts with another request.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            },
            "examples": {
              "Example - Full": {
                "summary": "Example - Full",
                "value": {
                  "object": "error",
                  "code": "unknown",
                  "details": [
                    {
                      "object": "propertyErrorDetail",
                      "code": "propertyRequired",
                      "message": "Invalid value for property.",
                      "property": "property1",
                      "suggestion": "alternative_value"
                    }
                  ],
                  "documentation": [
                    "https://developers.gigs.com/api/error-handling"
                  ],
                  "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              },
              "Example - Required": {
                "summary": "Example - Required",
                "value": {
                  "object": "error",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              }
            }
          }
        }
      },
      "unprocessableEntity": {
        "description": "The request can't be processed, often due to an invalid parameter or incompatible system state.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            },
            "examples": {
              "Example - Full": {
                "summary": "Example - Full",
                "value": {
                  "object": "error",
                  "code": "unknown",
                  "details": [
                    {
                      "object": "propertyErrorDetail",
                      "code": "propertyRequired",
                      "message": "Invalid value for property.",
                      "property": "property1",
                      "suggestion": "alternative_value"
                    }
                  ],
                  "documentation": [
                    "https://developers.gigs.com/api/error-handling"
                  ],
                  "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              },
              "Example - Required": {
                "summary": "Example - Required",
                "value": {
                  "object": "error",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              }
            }
          }
        }
      },
      "notImplemented": {
        "description": "The type of request is not supported.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            },
            "examples": {
              "Example - Full": {
                "summary": "Example - Full",
                "value": {
                  "object": "error",
                  "code": "unknown",
                  "details": [
                    {
                      "object": "propertyErrorDetail",
                      "code": "propertyRequired",
                      "message": "Invalid value for property.",
                      "property": "property1",
                      "suggestion": "alternative_value"
                    }
                  ],
                  "documentation": [
                    "https://developers.gigs.com/api/error-handling"
                  ],
                  "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              },
              "Example - Required": {
                "summary": "Example - Required",
                "value": {
                  "object": "error",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              }
            }
          }
        }
      },
      "serviceUnavailable": {
        "description": "The network provider required to perform the request is currently unavailable. Please check [documentation](https://developers.gigs.com/api/error-handling#common-errors) for details on how to handle this error.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            },
            "examples": {
              "Example - Full": {
                "summary": "Example - Full",
                "value": {
                  "object": "error",
                  "code": "unknown",
                  "details": [
                    {
                      "object": "propertyErrorDetail",
                      "code": "propertyRequired",
                      "message": "Invalid value for property.",
                      "property": "property1",
                      "suggestion": "alternative_value"
                    }
                  ],
                  "documentation": [
                    "https://developers.gigs.com/api/error-handling"
                  ],
                  "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              },
              "Example - Required": {
                "summary": "Example - Required",
                "value": {
                  "object": "error",
                  "message": "Invalid ICCID format.",
                  "type": "invalid"
                }
              }
            }
          }
        }
      }
    },
    "parameters": {
      "addon": {
        "name": "addon",
        "in": "path",
        "description": "The unique identifier for the add-on.",
        "required": true,
        "schema": {
          "type": "string",
          "examples": [
            "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
          ]
        }
      },
      "listAfter": {
        "name": "after",
        "in": "query",
        "description": "A cursor for use in pagination. The `after` parameter takes an object ID that defines the position in the list, only items immediately following the item with that ID will be returned.",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "listBefore": {
        "name": "before",
        "in": "query",
        "description": "A cursor for use in pagination. The `before` parameter takes an object ID that defines the position in the list, only items immediately preceding the item with that ID will be returned.",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "listLimit": {
        "name": "limit",
        "in": "query",
        "description": "The limit of items to be returned in the list, between 0 and 200.",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 10,
          "maximum": 200,
          "minimum": 0,
          "examples": [
            20
          ]
        }
      },
      "plan": {
        "name": "plan",
        "in": "path",
        "description": "The unique identifier for the plan.",
        "required": true,
        "schema": {
          "type": "string",
          "examples": [
            "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
          ]
        }
      },
      "project": {
        "name": "project",
        "in": "path",
        "description": "The unique identifier for the [project](https://developers.gigs.com/core/projects#the-project-resource).",
        "required": true,
        "schema": {
          "type": "string",
          "examples": [
            "gigs"
          ]
        }
      },
      "subscriptionGroup": {
        "name": "subscriptionGroup",
        "in": "path",
        "description": "The unique identifier for the subscription group.",
        "required": true,
        "schema": {
          "type": "string",
          "examples": [
            "sgr_0SNlurA049MEWV26leJMWPp4o23C"
          ]
        }
      },
      "user": {
        "name": "user",
        "in": "path",
        "description": "The unique identifier for the user.",
        "required": true,
        "schema": {
          "type": "string",
          "examples": [
            "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
          ]
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Add-ons",
      "description": "Operations to manage add-ons."
    },
    {
      "name": "Consent Requests",
      "description": "Operations to manage consent requests."
    },
    {
      "name": "Devices",
      "description": "Operations to manage devices."
    },
    {
      "name": "Network Availabilities",
      "description": "Operations to lookup network availability information."
    },
    {
      "name": "Plans",
      "description": "Operations to manage plans."
    },
    {
      "name": "Portings",
      "description": "Operations to manage portings."
    },
    {
      "name": "Port Outs",
      "description": "Operations to manage port outs."
    },
    {
      "name": "Projects",
      "description": "Operations to manage projects."
    },
    {
      "name": "Roaming",
      "description": "Events about using mobile networks abroad."
    },
    {
      "name": "SIMs",
      "description": "Operations to manage SIMs."
    },
    {
      "name": "Subscriptions",
      "description": "Operations to manage subscriptions."
    },
    {
      "name": "Subscription Add-ons",
      "description": "Operations to manage subscription add-ons."
    },
    {
      "name": "Subscription Changes",
      "description": "Operations to manage subscription changes."
    },
    {
      "name": "Usage",
      "description": "View usage records."
    },
    {
      "name": "Usage Balances",
      "description": "Operations to manage usage balances."
    },
    {
      "name": "Users",
      "description": "Operations to manage users."
    },
    {
      "name": "User Addresses",
      "description": "Operations to manage user addresses."
    },
    {
      "name": "Credit Notes",
      "description": "Operations to manage credit notes."
    },
    {
      "name": "Invoices",
      "description": "Operations to manage invoices."
    },
    {
      "name": "Quotes",
      "description": "Operations to manage quotes."
    },
    {
      "name": "Vouchers",
      "description": "Operations to manage vouchers."
    },
    {
      "name": "Payments",
      "description": "Operations to manage payments."
    },
    {
      "name": "Payment Methods",
      "description": "Operations to manage payment methods."
    },
    {
      "name": "Connect Sessions",
      "description": "Operations to manage Connect sessions."
    },
    {
      "name": "API Keys",
      "description": "Events about API keys."
    },
    {
      "name": "Installations",
      "description": "Events about installations."
    },
    {
      "name": "Subscription Groups",
      "description": "Events about subscription groups."
    },
    {
      "name": "Virtual Numbers",
      "description": "Events about virtual numbers."
    }
  ],
  "x-tagGroups": [
    {
      "name": "Core",
      "tags": [
        "Add-ons",
        "Consent Requests",
        "Devices",
        "Network Availabilities",
        "Plans",
        "Portings",
        "Port Outs",
        "Projects",
        "Roaming",
        "SIMs",
        "Subscriptions",
        "Subscription Add-ons",
        "Subscription Changes",
        "Usage",
        "Usage Balances",
        "Users",
        "User Addresses"
      ]
    },
    {
      "name": "Billing",
      "tags": [
        "Credit Notes",
        "Invoices",
        "Quotes",
        "Vouchers"
      ]
    },
    {
      "name": "Payments",
      "tags": [
        "Payments",
        "Payment Methods"
      ]
    },
    {
      "name": "Connect",
      "tags": [
        "Connect Sessions"
      ]
    },
    {
      "name": "Other events",
      "tags": [
        "API Keys",
        "Installations",
        "Subscription Groups",
        "Virtual Numbers"
      ]
    }
  ]
}