HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
Guides
These docs are for v2023.12.01. Click to read the latest docs for v2024.08.01.

SERVICE_CHECKOUT_SUCCESS

{
  "type" : "object",
  "properties" : {
    "customerId" : {
      "type" : "string"
    },
    "externalUniqueIdentifier" : {
      "type" : "string"
    },
    "username" : {
      "type" : "string"
    },
    "email" : {
      "type" : "string"
    },
    "title" : {
      "type" : "string"
    },
    "firstName" : {
      "type" : "string"
    },
    "lastName" : {
      "type" : "string"
    },
    "dateOfBirth" : {
      "type" : "string",
      "format" : "date-time"
    },
    "countryCode" : {
      "type" : "string"
    },
    "postCode" : {
      "type" : "string"
    },
    "consents" : {
      "type" : "object",
      "properties" : {
        "contactMethods" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "consentPrefs" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        }
      }
    },
    "customAttributes" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "value" : {
            "type" : "string"
          }
        }
      }
    },
    "entitlements" : {
      "type" : "object",
      "properties" : {
        "subscriptions" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "properties" : {
              "itemCode" : {
                "type" : "string"
              },
              "itemName" : {
                "type" : "string"
              },
              "entitlementIds" : {
                "type" : "array",
                "items" : {
                  "type" : "string"
                }
              },
              "entitlements" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "properties" : {
                    "id" : {
                      "type" : "string"
                    },
                    "name" : {
                      "type" : "string"
                    }
                  }
                }
              },
              "vcn" : {
                "type" : "integer"
              }
            }
          }
        },
        "ppv" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "properties" : {
              "itemCode" : {
                "type" : "string"
              },
              "itemName" : {
                "type" : "string"
              },
              "entitlementIds" : {
                "type" : "array",
                "items" : {
                  "type" : "string"
                }
              },
              "entitlements" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                }
              },
              "itemDataId" : {
                "type" : "string"
              },
              "itemDataName" : {
                "type" : "string"
              },
              "vcn" : {
                "type" : "integer"
              }
            }
          }
        },
        "accessPasses" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "properties" : {
              "itemCode" : {
                "type" : "string"
              },
              "itemName" : {
                "type" : "string"
              },
              "entitlementIds" : {
                "type" : "array",
                "items" : {
                  "type" : "string"
                }
              },
              "entitlements" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                }
              },
              "itemDataId" : {
                "type" : "string"
              },
              "itemDataName" : {
                "type" : "string"
              },
              "groupName" : {
                "type" : "string"
              },
              "startTime" : {
                "type" : "string",
                "format" : "date-time"
              },
              "endTime" : {
                "type" : "string",
                "format" : "date-time"
              },
              "hoursDuration" : {
                "type" : "integer"
              }
            }
          }
        },
        "vcn" : {
          "type" : "array",
          "items" : {
            "type" : "integer"
          }
        }
      }
    },
    "referAFriend" : {
      "type" : "object",
      "properties" : {
        "code" : {
          "type" : "string"
        },
        "active" : {
          "type" : "boolean"
        }
      }
    },
    "paymentMethod" : {
      "type" : "object",
      "properties" : {
        "paymentProvider" : {
          "type" : "string"
        },
        "paymentType" : {
          "type" : "string"
        },
        "maskedPAN" : {
          "type" : "string"
        },
        "expiryDate" : {
          "type" : "string",
          "format" : "date-time"
        }
      }
    },
    "amount" : {
      "type" : "number"
    },
    "currency" : {
      "type" : "string"
    },
    "itemsPurchased" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "itemCode" : {
            "type" : "string"
          },
          "itemType" : {
            "type" : "string"
          },
          "referrerId" : {
            "type" : "string"
          },
          "entitlements" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "id" : {
                  "type" : "string"
                },
                "name" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "discount" : {
      "type" : "object",
      "properties" : {
        "campaignCode" : {
          "type" : "string"
        },
        "sourceCode" : {
          "type" : "string"
        },
        "promoCode" : {
          "type" : "string"
        },
        "referAFriendCode" : {
          "type" : "string"
        },
        "name" : {
          "type" : "string"
        },
        "amount" : {
          "type" : "number"
        },
        "duration" : {
          "type" : "integer"
        }
      }
    },
    "minimumTermDuration" : {
      "type" : "integer"
    },
    "minimumTermUnit" : {
      "type" : "string"
    },
    "termEndDate" : {
      "type" : "string",
      "format" : "date-time"
    },
    "billingDate" : {
      "type" : "string",
      "format" : "date-time"
    },
    "orderId" : {
      "type" : "number"
    },
    "initialCharge" : {
      "type" : "number"
    },
    "recurringCharge" : {
      "type" : "number"
    }
  },
  "required": ["customerId", "username", "email", "title", "firstName", "lastName", "countryCode", "consents", "amount", "currency", "itemsPurchased"]
}