👍

Check the marketplace

Payloads differ between different marketplaces. Make sure you're on the right cloud tab when you check for your sample payloads!

New Orders

{
  "event_type": "order_created",
  "vendorid": "U9T21A",
  "productid": "8q5lbvh8cjannu8h14tuqkj5t",
  "customerid": "ij3sXMkN3or",
  "marketplace": "aws",
  "tackle_subscription_change_id": "4fk_28n492h",
  "entitlements": [
    {
      "dimension": "awsdimension_1",
      "skuid": "awsdimension_apiname_1",
      "expiration": "2020-06-25T15:31:19.479000+00:00",
      "value": 1
    }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "offer-abcdefghijkl1",
  "contract_metadata": {
    "key": "value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "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"
    },
    "pre_registration_details": {
      "Company": "Example Company"
    }
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {
    "data": {
      "CustomerAWSAccountId": "example-account-id"
    }
  }
}
{
  "event_type": "order_created",
  "vendorid": "U9T21A",
  "productid": "tackle-azure-platform",
  "customerid": "1b3gs3f4-2794-abcd-3fa3-062fa0s3t3re",
  "marketplace": "azure",
  "entitlements": [
   {
       "plan": "tackleazureplatform_azurelisting",
       "quantity": 1,
       "subscription_id": "1b3gs3f4-2794-abcd-3fa3-062fa0s3t3re",
       "subscription_name": "Tackle Azure Platform",
       "offer_id": "tackle-azure-platform",
   }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "payerid": "000000000-1111-2222-3333-444444444444",
  "offerid": "sample_azure_offer_id1",                     
  "contract_metadata": {                                        
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {},
    "pre_registration_details": {
      "Company": "Example Company"
    }
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}
}
{
  "event_type": "order_created",
  "vendorid": "U9T21A",
  "productid": "tackle-on-gcp",
  "customerid": "E-ABC2-D530-E2FG-H2Q2",
  "marketplace": "gcp",
  "entitlements": [
    {
      "account": "providers/tackle-public/accounts/E-ABC2-D530-E2FG-H2Q2",
      "createTime": "2019-10-25T21:38:20.865Z",
      "name": "providers/tackle-public/entitlements/416bacaa-94b6-4701-911bf945aab9",
      "plan": "tkl-tier-1",
      "product": "tackle-on-gcp",
      "state": "ENTITLEMENT_ACTIVE",
      "usageReportingId": "project_number:1234567890"
    }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "a1b2c3e4-a1b2-a1b2-a1b2-a1b2c3d4e5f6",       
  "contract_metadata": {                                        
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {},
    "pre_registration_details": {
      "Company": "Example Company"
    }
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}
}
{
  "event_type": "order_created",
  "vendorid": "U9T21A",
  "productid": "d3m012b345678cd9e1234f56gh78ij90",
  "customerid": "d3m023c9d3a15b420c4ab123",
  "marketplace": "redhat",
  "entitlements": [
    {
      "subscription_id": "MOCK-CUSTOMER",
      "edition_id": "test_edition_123123-12321-5455123",
      "edition_name": "Test Edition 1",
      "attributes": {
        "part1": 10,
        "sku1": 50,
        "part2": "PREMIUM",
        "sku2": 50
      },
      "term": 12,
      "term_unit": "MONTHS",
      "term_end_date": "2022-10-18T11:34:41.062665",
      "type": "PURCHASE",
      "renew_type": "ORIGINAL_TERM"
    }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "offer-abcdefghijkl1",
  "contract_metadata": {                                      
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {
      "dimensions": [
        {
          "dimension_value": "1234",
          "name": "Extend",
          "price": "1234",
          "quantity": "1"
        }
      ],
      "duration": "12 Months",
      "monthly_contract_value": "1234",
      "total_contract_value": "1234",
      "version": "simple-pricing-v1"
    }
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}
}

Order Modification

order_modified events return a list of all existing entitlements. This means that if an order originally contained Entitlement A and Entitlement B was added to it, the order_modified event you receive will contain both Entitlements A and B.

On AWS and GCP, we will send an order_modified event if an order is auto-renewed.
We currently do not send new events on auto-renew on Azure.

{
  "event_type": "order_modified",
  "vendorid": "U9T21A",
  "productid": "8q5lbvh8cjannu8h14tuqkj5t",
  "customerid": "ij3sXMkN3or",
  "marketplace": "aws",
  "tackle_subscription_change_id": "3sdgkf84_s1",
  "entitlements": [
    {
      "dimension": "awsdimension_1",
      "skuid": "awsdimension_apiname_1",
      "expiration": "2021-06-25T15:31:19.479000+00:00",
      "value": 5
    }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "offer-abcdefghijkl1",  
  "contract_metadata": {                                        
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "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"
    },
    "pre_registration_details": {
      "Company": "Example Company"
    }
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {
    "data": {
      "CustomerAWSAccountId": "example-account-id"
    }
  }
}
{
  "event_type": "order_modified",
  "vendorid": "U9T21A",
  "productid": "tackle-azure-platform",
  "customerid": "1b3gs3f4-2794-abcd-3fa3-062fa0s3t3re",
  "marketplace": "azure",
  "entitlements": [
   {
       "plan": "tackleazureplatform_azurelisting",
       "quantity": 5,
       "subscription_id": "1b3gs3f4-2794-abcd-3fa3-062fa0s3t3re",
       "subscription_name": "Tackle Azure Platform",
       "offer_id": "tackle-azure-platform",
   }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "payerid": "000000000-1111-2222-3333-444444444444",
  "offerid": "sample_azure_offer_id1",                     
  "contract_metadata": {                                        
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {}
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}    
}
{
  "event_type": "order_modified",
  "vendorid": "U9T21A",
  "productid": "tackle-on-gcp",
  "customerid": "E-ABC2-D530-E2FG-H2Q2",
  "marketplace": "gcp",
  "entitlements": [
    {
      "account": "providers/tackle-public/accounts/E-ABC2-D530-E2FG-H2Q2",
      "createTime": "2019-10-25T21:38:20.865Z",
      "name": "providers/tackle-public/entitlements/416bacaa-94b6-4701-911bf945aab9",
      "plan": "tkl-tier-1",
      "product": "tackle-on-gcp",
      "state": "ENTITLEMENT_CANCELLED"
    },
    {
      "account": "providers/tackle-public/accounts/E-ABC2-D530-E2FG-H2Q2",
      "createTime": "2019-12-25T21:38:20.865Z",
      "name": "providers/tackle-public/entitlements/124bgra-94b6-4701-235bf912asb9",
      "plan": "tkl-tier-5",
      "product": "tackle-on-gcp",
      "state": "ENTITLEMENT_ACTIVE"
    }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "a1b2c3e4-a1b2-a1b2-a1b2-a1b2c3d4e5f6",       
  "contract_metadata": {                                        
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {}
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}   
}
{
  "event_type": "order_modified",
  "vendorid": "U9T21A",
  "productid": "d3m012b345678cd9e1234f56gh78ij90",
  "customerid": "d3m023c9d3a15b420c4ab123",
  "marketplace": "redhat",
  "entitlements": [
    {
      "subscription_id": "MOCK-CUSTOMER",
      "edition_id": "test_edition_123123-12321-5455123",
      "edition_name": "Test Edition 1",
      "attributes": {
        "part1": 10,
        "sku1": 50,
        "part2": "PREMIUM",
        "sku2": 50
      },
      "term": 12,
      "term_unit": "MONTHS",
      "term_end_date": "2022-10-18T11:34:41.062665",
      "type": "PURCHASE",
      "renew_type": "ORIGINAL_TERM"
    }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "offer-abcdefghijkl1",  
  "contract_metadata": {                                        
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {},
    "pre_registration_details": {
      "Company": "Example Company"
    }
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}
}

Order Cancellation

{
  "event_type": "order_cancelled",
  "vendorid": "U9T21A",
  "productid": "8q5lbvh8cjannu8h14tuqkj5t",
  "customerid": "ij3sXMkN3or",
  "marketplace": "aws",
  "tackle_subscription_change_id": "g4lg2f84_s1",
  "entitlements": [],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "offer-abcdefghijkl1",  
  "contract_metadata": {                                        
     "key":"value"
  }, 
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {},
    "pre_registration_details": {
      "Company": "Example Company"
    }
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {
    "data": {
      "CustomerAWSAccountId": "example-account-id"
    }
  }
}
{
  "event_type": "order_cancelled",
  "vendorid": "U9T21A",
  "productid": "tackle-azure-platform",
  "customerid": "1b3gs3f4-2794-abcd-3fa3-062fa0s3t3re",
  "marketplace": "azure",
  "entitlements": [],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "payerid": "000000000-1111-2222-3333-444444444444",
  "offerid": "sample_azure_offer_id1",
  "contract_metadata": {                                        
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {}
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}
}
{
  "event_type": "order_cancelled",
  "vendorid": "U9T21A",
  "productid": "tackle-on-gcp",
  "customerid": "E-ABC2-D530-E2FG-H2Q2",
  "marketplace": "gcp",
  "entitlements": [
    {
      "account": "providers/tackle-public/accounts/E-ABC2-D530-E2FG-H2Q2",
      "createTime": "2019-10-25T21:38:20.865Z",
      "name": "providers/tackle-public/entitlements/416bacaa-94b6-4701-911bf945aab9",
      "plan": "tkl-tier-1",
      "product": "tackle-on-gcp",
      "state": "ENTITLEMENT_CANCELLED"
    }
  ],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "a1b2c3e4-a1b2-a1b2-a1b2-a1b2c3d4e5f6",       
  "contract_metadata": {                                        
     "key":"value"
  },
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {}
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}
}
{
  "event_type": "order_cancelled",
  "vendorid": "U9T21A",
  "productid": "d3m012b345678cd9e1234f56gh78ij90",
  "customerid": "d3m023c9d3a15b420c4ab123",
  "marketplace": "redhat",
  "entitlements": [],
  "properties": {
    "Company": "Tackle",
    "Company Address": "104 S. Capitol Blvd.",
    "Company Website": "https://tackle.io",
    "Email Address": "[email protected]",
    "Full Name": "Jane Doe",
    "Phone Number": "1234567890"
  },
  "offerid": "offer-abcdefghijkl1",  
  "contract_metadata": {                                        
     "key":"value"
  }, 
  "private_offer_metadata": {
    "buyers": [
      {
        "full_name": "Example Person",
        "email_address": "[email protected]",
        "title": "CEO"
      }
    ],
    "offer_metadata": {},
    "renewal": false,
    "eula": {
      "files": []
    },
    "enable_zero_dollar_prices": false,
    "offer_expiration_at": "2022-08-12T12:00:00+00:00",
    "pricing": {},
    "pre_registration_details": {
      "Company": "Example Company"
    }
  },
  "pricing": {},
  "is_free_trial": false,
  "tackle_subscription_id": "52fZSV7JbMI",
  "marketplace_data": {}
}