The following payloads lay out an example lifecycle for a Private Offer. These payloads contain mock data in example formats. Payloads for all cloud marketplaces will follow the same format.
A new Private Offer is created
For Azure Private Offers, when long-term SAAS pricing plans are enabled, the payment_info field will be included in the dimension object within private_offer_metadata.pricing.dimensions for all event types. Otherwise, this field will not be present.
{
"actor": {
"email": "[email protected]",
"name": "John Smith",
"picture": "https://www.example.com/jpeg",
"user_id": "abc123"
},
"marketplace": "aws",
"created_at": "2021-02-16T14:48:06.460998+00:00",
"customerid": "ij3sXMkN3or",
"destination": "callback",
"event_type": "private_offer_created",
"extra_data": {},
"group_id": "5e7b1ec8-2595-40c7-b6f1-3b0d1fd1ed9e",
"offerid": "offer-abcdefghijkl1",
"po_id": "7ec896c2-6cff-4a46-b55a-039db504422d",
"productid": "A0BCD23E",
"source": "po_url",
"private_offer_metadata": {
"buyers": [
{
"title": "Buyer",
"email_address": "[email protected]",
"full_name": "Bertram Gilfoyle"
}
],
"renewal": false,
"eula": {
"type": "public",
"files": []
},
"enable_zero_dollar_prices": false,
"offer_metadata": {
"AWS Account Number": "533037066561"
},
"pre_registration_details": {
"billing_street": "1 Pied Way",
"billing_country": "United States",
"billing_city": "Redwood City",
"Company": "Pied Piper",
"billing_state": "CA"
},
"pricing": {
"net_contract_value": "40000.00",
"duration": "1 Months",
"schedule": [
{
"invoice_amount": "1000.00",
"invoice_date": "2021-10-22T00:00:00.000-06:00"
},
{
"invoice_amount": "500.00",
"invoice_date": "2021-11-23T00:00:00.000-06:00"
}
],
"show_on_email": false,
"marketplace_fee": "0.00",
"monthly_contract_value": "20000.00",
"version": "simple-pricing-v1-aws",
"dimensions": [
{
"name": "Enterprise",
"dimension_value": "40000",
"quantity": "2",
"price": "20000"
}
],
"total_contract_value": "40000.00"
},
"offer_expiration_at": "",
"accepted_at": "",
"cancelled_at": "",
"archived_at": "",
"opened_instructions_at": "",
"viewed_offer_at": "",
"last_modified_at": "2021-02-16T14:48:06.460998Z"
},
"vendorid": "U9T21A",
"is_free_trial": false,
"tackle_subscription_id": "52fZSV7JbMI",
"test": false
}
{
"group_id": "2h58473p-c70i-1234-9d7b-7we9585e2c9w",
"created_at": "2021-11-09T16:29:24.707456+00:00",
"actor": {
"email": "[email protected]",
"name": "John Smith",
"picture": "https://www.example.com/jpeg",
"user_id": "abc123"
},
"customerid": "2h58473p-c70i-1234-9d7b-7we9585e2c9w",
"destination": "callback",
"event_type": "private_offer_created",
"extra_data": {},
"marketplace": "azure",
"offerid": "00-000-apitest-private",
"po_id": "2h58473p-c70i-1234-9d7b-7we9585e2c9w",
"private_offer_metadata": {
"buyers": [
{
"email_address": "[email protected]",
"full_name": "John Smith",
"title": "Example Title"
},
{
"email_address": "[email protected]",
"full_name": "John Smith",
"title": "Example Title"
}
],
"enable_zero_dollar_prices": false,
"eula": {
"files": []
},
"offer_metadata": {},
"pre_registration_details": {
"Company": "Example Company"
},
"pricing": {
"dimensions": [
{
"dimension_value": "0",
"name": "00-000-500-apitest-private",
"price": "0",
"quantity": "1",
"payment_info": [
{
"payment": "1 month, paid one-time upfront",
"price_per_payment_in_usd": "12.00",
"total_payments": "12.00"
}
],
},
],
"duration": "Annual",
"marketplace_fee": "0.00",
"monthly_contract_value": "0.00",
"net_contract_value": "0.00",
"show_on_email": false,
"total_contract_value": "0.00",
"version": "simple-pricing-v1-azure"
},
"renewal": false
},
"productid": "product-id",
"source": "po_url",
"test": false,
"vendorid": "ABC123"
}
{
"group_id": "2h58473p-c70i-1234-9d7b-7we9585e2c9w",
"created_at": "2022-01-31T23:31:22.166934+00:00",
"actor": {
"email": "[email protected]",
"name": "John Smith",
"picture": "https://www.example.com/jpeg",
"user_id": "abc123"
},
"destination": "callback",
"event_type": "private_offer_created",
"extra_data": {},
"marketplace": "gcp",
"offerid": "2h58473p-c70i-1234-9d7b-7we9585e2c9w",
"po_id": "2h58473p-c70i-1234-9d7b-7we9585e2c9w",
"private_offer_metadata": {
"buyers": [
{
"email_address": "[email protected]",
"full_name": "John Smith",
"title": "Example Title"
}
],
"enable_zero_dollar_prices": false,
"eula": {
"files": []
},
"offer_metadata": {
"Quote ID": "2h58473p-c70i-1234-9d7b-7we9585e2c9w"
},
"pre_registration_details": {
"Company": "Example Company"
},
"pricing": {
"dimensions": [],
"duration": "1 Months",
"marketplace_fee": "0.000000",
"show_on_email": false,
"version": "simple-pricing-v2-gcp"
},
"renewal": false
},
"productid": "product-example",
"source": "po_url",
"test": false,
"vendorid": "ABC123"
}
{
"cloud": "redhat",
"metadata": {
"buyers": [
{
"title": "Sr. Test",
"full_name": "Someone That Buys",
"email_address": "[email protected]"
}
],
"renewal": false,
"eula": {
"files": []
},
"enable_zero_dollar_prices": false,
"offer_metadata": {
"RHM Account ID": "123456789"
},
"pre_registration_details": {
"Company": "Test"
},
"offer_expiration_at": "2022-05-31T00:00:00.000Z",
"pricing": {
"pricing_type": "marketplace-pricing-v1-redhat",
"offer_terms": [
{
"term": "12",
"term_unit": "MONTHS",
"charges": [{"id": "123", "quantity": "4", "unit_price": "15500.00"}]
}
],
"account_id": "ad6218f0-e07a-11e9-a1c9-bd48ff9cc364",
"edition_id": "EIDJWBWL",
"billing_frequency": "MONTHLY",
"marketplace_fee": "1.0"
}
},
"po_ref": "redhat#DEMOVENDOR1-redhat-1603121145#None#None#6894afad-1cc2-40fc-8d96-b7f96699d95c",
"po_id": "6894afad-1cc2-40fc-8d96-b7f96699d95c",
"activities": [
{
"created_at": "2022-05-27T18:03:37.589597+00:00",
"metadata": {
"user": {
"name": "John Smith",
"email": "[email protected]",
"buyer": false
}
},
"user_id": "abc123",
"slug": "vendor-created-offer",
"activity_type": "PO"
}
],
"vendor_id": "DEMOVENDOR1",
"users_to_notify": [
{
"value": "john smith",
"contact_type": "auth0"
}
],
"created_at": "2022-05-27T18:03:37.590560+00:00",
"product_ref": "example-redhat-1603100000",
"last_modified_at": "2022-05-27T18:03:37.589504+00:00",
"test": false
}
Purchase instructions are sent
{
"actor": {
"email": "[email protected]",
"name": "John Smith",
"picture": "https://www.example.com/jpeg",
"user_id": "abc123"
},
"marketplace": "aws",
"created_at": "2021-02-05T23:00:31.215975+00:00",
"customerid": "IJjandEMmnB",
"destination": "callback",
"event_type": "private_offer_purchase_instructions_sent",
"extra_data": {},
"group_id": "2222c189-6617-4b7c-a52f-e70f07f06a34",
"offerid": "offer-abcdefghijkl1",
"po_id": "7ec896c2-6cff-4a46-b55a-039db504422d",
"productid": "A0BCD23E",
"source": "po_url",
"private_offer_metadata": {
"buyers": [
{
"title": "Buyer",
"email_address": "[email protected]",
"full_name": "Bertram Gilfoyle"
}
],
"renewal": false,
"eula": {
"type": "public",
"files": []
},
"enable_zero_dollar_prices": false,
"offer_metadata": {
"AWS Account Number": "533037066561"
},
"pre_registration_details": {
"billing_street": "1 Pied Way",
"billing_country": "United States",
"billing_city": "Redwood City",
"Company": "Pied Piper",
"billing_state": "CA"
},
"pricing": {
"net_contract_value": "40000.00",
"duration": "1 Months",
"schedule": [],
"show_on_email": false,
"marketplace_fee": "0.00",
"monthly_contract_value": "20000.00",
"version": "simple-pricing-v1-aws",
"dimensions": [
{
"name": "Enterprise",
"dimension_value": "40000",
"quantity": "2",
"price": "20000"
}
],
"total_contract_value": "40000.00"
},
"offer_expiration_at": "2021-12-31T00:00:00.000Z",
"accepted_at": "",
"cancelled_at": "",
"archived_at": "",
"opened_instructions_at": "",
"viewed_offer_at": "",
"last_modified_at": "2021-02-01T09:29:00.00.000Z"
},
"vendorid": "U9T21A",
"is_free_trial": false,
"tackle_subscription_id": "52fZSV7JbMI",
"test": false
}
Buyer opened the purchase instructions email
{
"actor": {
"email": "[email protected]",
"name": "John Smith",
"picture": "https://www.example.com/jpeg",
"user_id": "abc123"
},
"marketplace": "aws",
"created_at": "2021-02-10T15:18:17.584888+00:00",
"customerid": "IJjandEMmnB",
"destination": "callback",
"event_type": "private_offer_invitation_opened",
"extra_data": {
"users": [
{
"buyer": null,
"email": "[email protected]",
"name": "Brian Levenson",
"picture": "https://lh5.googleusercontent.com/-QMVY0SvdyT0/AAAAAAAAAAI/AAAAAAAAAAA/AMZuucnyRpk0Yn1rkHadiWbNEPOTBCG9Uw/s96-c/photo.jpg",
"user_id": "google-oauth2|104359829503500435928"
}
]
},
"group_id": "f579b0c2-837b-4b77-84fa-32ded5d65566",
"offerid": "offer-abcdefghijkl1",
"po_id": "7ec896c2-6cff-4a46-b55a-039db504422d",
"productid": "A0BCD23E",
"source": "email-webhook",
"private_offer_metadata": {
"buyers": [
{
"title": "Buyer",
"email_address": "[email protected]",
"full_name": "Bertram Gilfoyle"
}
],
"renewal": false,
"eula": {
"type": "public",
"files": []
},
"enable_zero_dollar_prices": false,
"offer_metadata": {
"AWS Account Number": "533037066561"
},
"pre_registration_details": {
"billing_street": "1 Pied Way",
"billing_country": "United States",
"billing_city": "Redwood City",
"Company": "Pied Piper",
"billing_state": "CA"
},
"pricing": {
"net_contract_value": "40000.00",
"duration": "1 Months",
"schedule": [],
"show_on_email": false,
"marketplace_fee": "0.00",
"monthly_contract_value": "20000.00",
"version": "simple-pricing-v1-aws",
"dimensions": [
{
"name": "Enterprise",
"dimension_value": "40000",
"quantity": "2",
"price": "20000"
}
],
"total_contract_value": "40000.00"
},
"offer_expiration_at": "2021-12-31T00:00:00.000Z",
"accepted_at": "",
"cancelled_at": "",
"archived_at": "",
"opened_instructions_at": "2021-02-02T16:53:23.00.000Z",
"viewed_offer_at": "",
"last_modified_at": "2021-02-01T09:29:00.00.000Z"
},
"vendorid": "U9T21A",
"is_free_trial": false,
"tackle_subscription_id": "52fZSV7JbMI",
"test": false
}
Buyer has viewed the private offer
{
"actor": {
"email": "[email protected]",
"name": "John Smith",
"picture": "https://www.example.com/jpeg",
"user_id": "abc123"
},
"marketplace": "aws",
"created_at": "2021-02-05T23:00:31.334844+00:00",
"customerid": "IJjandEMmnB",
"destination": "callback",
"event_type": "private_offer_viewed",
"extra_data": {},
"group_id": "251d238f-1bef-46d0-b01f-6628027ef4d9",
"offerid": "offer-abcdefghijkl1",
"po_id": "7ec896c2-6cff-4a46-b55a-039db504422d",
"productid": "A0BCD23E",
"source": "po_url",
"private_offer_metadata": {
"buyers": [
{
"title": "Buyer",
"email_address": "[email protected]",
"full_name": "Bertram Gilfoyle"
}
],
"renewal": false,
"eula": {
"type": "public",
"files": []
},
"enable_zero_dollar_prices": false,
"offer_metadata": {
"AWS Account Number": "533037066561"
},
"pre_registration_details": {
"billing_street": "1 Pied Way",
"billing_country": "United States",
"billing_city": "Redwood City",
"Company": "Pied Piper",
"billing_state": "CA"
},
"pricing": {
"net_contract_value": "40000.00",
"duration": "1 Months",
"schedule": [],
"show_on_email": false,
"marketplace_fee": "0.00",
"monthly_contract_value": "20000.00",
"version": "simple-pricing-v1-aws",
"dimensions": [
{
"name": "Enterprise",
"dimension_value": "40000",
"quantity": "2",
"price": "20000"
}
],
"total_contract_value": "40000.00"
},
"offer_expiration_at": "2021-12-31T00:00:00.000Z",
"accepted_at": "",
"cancelled_at": "",
"archived_at": "",
"opened_instructions_at": "2021-02-02T16:53:23.00.000Z",
"viewed_offer_at": "2021-02-01T13:04:23.00.000Z",
"last_modified_at": "2021-02-01T09:29:00.00.000Z"
},
"vendorid": "U9T21A",
"is_free_trial": false,
"tackle_subscription_id": "52fZSV7JbMI",
"test": false
}
Buyer has accepted the private offer
{
"actor": {
"email": "[email protected]",
"name": "John Smith",
"picture": "https://www.example.com/jpeg",
"user_id": "abc123"
},
"marketplace": "aws",
"created_at": "2021-02-05T23:00:31.254540+00:00",
"customerid": "IJjandEMmnB",
"destination": "callback",
"event_type": "private_offer_accepted",
"extra_data": {
"users": [
"[email protected]"
]
},
"group_id": "b28304c8-f42d-455b-86f1-eb05c0777f01",
"offerid": "offer-abcdefghijkl1",
"po_id": "7ec896c2-6cff-4a46-b55a-039db504422d",
"productid": "A0BCD23E",
"source": "saas-url",
"private_offer_metadata": {
"buyers": [
{
"title": "Buyer",
"email_address": "[email protected]",
"full_name": "Bertram Gilfoyle"
}
],
"renewal": false,
"eula": {
"type": "public",
"files": []
},
"enable_zero_dollar_prices": false,
"offer_metadata": {
"AWS Account Number": "533037066561"
},
"pre_registration_details": {
"billing_street": "1 Pied Way",
"billing_country": "United States",
"billing_city": "Redwood City",
"Company": "Pied Piper",
"billing_state": "CA"
},
"pricing": {
"net_contract_value": "40000.00",
"duration": "1 Months",
"schedule": [],
"show_on_email": false,
"marketplace_fee": "0.00",
"monthly_contract_value": "20000.00",
"version": "simple-pricing-v1-aws",
"dimensions": [
{
"name": "Enterprise",
"dimension_value": "40000",
"quantity": "2",
"price": "20000"
}
],
"total_contract_value": "40000.00"
},
"offer_expiration_at": "2021-12-31T00:00:00.000Z",
"accepted_at": "2021-02-05T23:00:31.254540+00:00",
"cancelled_at": "",
"archived_at": "",
"opened_instructions_at": "2021-02-03T12:14:31.254540+00:00",
"viewed_offer_at": "2021-02-05T23:00:31.254540+00:00",
"last_modified_at": "2021-02-05T23:00:31.254540+00:00"
},
"vendorid": "U9T21A",
"is_free_trial": false,
"tackle_subscription_id": "52fZSV7JbMI",
"test": false
}