POST api/refreshtve
Request Information
URI Parameters
None.
Body Parameters
GlobalRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
None. |
|
| occurred_at | integer |
None. |
|
| source | string |
None. |
|
| user | string |
None. |
|
| object | string |
None. |
|
| api_version | string |
None. |
|
| content | GlobalContentRequest |
None. |
|
| event_type | string |
None. |
|
| webhook_status | string |
None. |
|
| method | string |
None. |
|
| web_log_id | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": "sample string 1",
"occurred_at": 2,
"source": "sample string 3",
"user": "sample string 4",
"object": "sample string 5",
"api_version": "sample string 6",
"content": {
"customer": {
"id": "sample string 1",
"first_name": "sample string 2",
"last_name": "sample string 3",
"email": "sample string 4",
"auto_collection": "sample string 5",
"net_term_days": 6,
"allow_direct_debit": true,
"created_at": 8,
"taxability": "sample string 9",
"updated_at": 10,
"resource_version": 11,
"deleted": true,
"object": "sample string 13",
"card_status": "sample string 14",
"primary_payment_source_id": "sample string 15",
"promotional_credits": 16,
"refundable_credits": 17,
"excess_payments": 18,
"unbilled_charges": 19,
"preferred_currency_code": "sample string 20",
"cf_customer_number": "sample string 21",
"cf_subsidiary": "sample string 22",
"cf_mobile_number": "sample string 23",
"cf_region": "sample string 24",
"cf_super_region": "sample string 25",
"cf_sub_region": "sample string 26",
"cf_do_not_call": "sample string 27",
"cf_do_not_email": "sample string 28",
"cf_paperless_billing": "sample string 29",
"cf_middle_initial": "sample string 30",
"cf_promise_to_pay_date": "sample string 31",
"cf_alt_email": "sample string 32",
"cf_opt_in_out_date": "sample string 33",
"cf_bankruptcy_notice_received_date": "sample string 34",
"cf_outstanding_balance": "sample string 35",
"IsSuccess": true,
"StatusCode": "sample string 37",
"ResponseBody": "sample string 38",
"StatusMessage": "sample string 39"
},
"subscription": {
"id": "sample string 1",
"customer_id": "sample string 2",
"plan_id": "sample string 3",
"plan_quantity": 4,
"plan_unit_price": 5,
"billing_period": 6,
"billing_period_unit": "sample string 7",
"remaining_billing_cycles": 8,
"plan_free_quantity": 9,
"status": "sample string 10",
"trial_start": 11,
"trial_end": 12,
"current_term_start": 13,
"current_term_end": 14,
"next_billing_at": 15,
"created_at": 16,
"started_at": 17,
"activated_at": 18,
"cancelled_at": 19,
"updated_at": 20,
"has_scheduled_changes": true,
"resource_version": 22,
"business_entity_id": "sample string 23",
"deleted": true,
"object": "sample string 25",
"currency_code": "sample string 26",
"due_invoices_count": 27,
"due_since": 28,
"total_dues": 29.1,
"mrr": 30,
"pause_date": 31,
"exchange_rate": 32.1,
"base_currency_code": "sample string 33",
"cancel_reason_code": "sample string 34",
"subscription_items": [
{
"item_price_id": "sample string 1",
"item_type": "sample string 2",
"quantity": 3,
"quantity_in_decimal": "sample string 4",
"unit_price": 5,
"unit_price_in_decimal": "sample string 6",
"amount": 7,
"amount_in_decimal": "sample string 8",
"free_quantity": 9,
"free_quantity_in_decimal": "sample string 10",
"object": "sample string 11",
"IsSuccess": true,
"StatusCode": "sample string 13",
"ResponseBody": "sample string 14",
"StatusMessage": "sample string 15"
},
{
"item_price_id": "sample string 1",
"item_type": "sample string 2",
"quantity": 3,
"quantity_in_decimal": "sample string 4",
"unit_price": 5,
"unit_price_in_decimal": "sample string 6",
"amount": 7,
"amount_in_decimal": "sample string 8",
"free_quantity": 9,
"free_quantity_in_decimal": "sample string 10",
"object": "sample string 11",
"IsSuccess": true,
"StatusCode": "sample string 13",
"ResponseBody": "sample string 14",
"StatusMessage": "sample string 15"
}
],
"cf_is_stripe": true,
"cf_tve_codes": "sample string 36",
"cf_claim_date": "sample string 37",
"cf_tve_code_to_change": "sample string 38",
"cf_unclaimed_tve_codes": "sample string 39",
"cf_sku_id": "sample string 40",
"cf_smartcard": "sample string 41",
"cf_mac_address": "sample string 42",
"cf_region_code": "sample string 43",
"cf_cas_codes": "sample string 44",
"cf_cas_codes_id": "sample string 45",
"cf_stb_type_id": "sample string 46",
"cf_service_internal_id": "sample string 47",
"cf_wallet_id": "sample string 48",
"cf_wallet_load": "sample string 49",
"cf_unclaimed_tve_code_1": "sample string 50",
"cf_unclaimed_tve_code_2": "sample string 51",
"cf_unclaimed_tve_code_3": "sample string 52",
"cf_unclaimed_tve_code_4": "sample string 53",
"cf_refresh": true,
"cf_refresh_status_message": "sample string 55",
"cf_tve_expiry_date": "sample string 56",
"cf_tve_plan": "sample string 57",
"cf_tve_email_add_non_stripe": "sample string 58",
"cf_tve_email_address_stripe": "sample string 59",
"IsSuccess": true,
"StatusCode": "sample string 61",
"ResponseBody": "sample string 62",
"StatusMessage": "sample string 63"
},
"invoice": {
"id": "sample string 1",
"customer_id": "sample string 2",
"subscription_id": "sample string 3",
"recurring": true,
"status": "sample string 5",
"price_type": "sample string 6",
"date": 7,
"due_date": 8,
"net_term_days": 9,
"exchange_rate": 10.1,
"total": 11,
"amount_paid": 12,
"amount_adjusted": 13,
"write_off_amount": 14,
"credits_applied": 15,
"amount_due": 16,
"dunning_status": "sample string 17",
"updated_at": 18,
"resource_version": 19,
"deleted": true,
"object": "sample string 21",
"first_invoice": true,
"amount_to_collect": 23,
"round_off_amount": 24,
"new_sales_amount": 25,
"has_advance_charges": true,
"currency_code": "sample string 27",
"base_currency_code": "sample string 28",
"generated_at": 29,
"is_gifted": true,
"term_finalized": true,
"channel": "sample string 32",
"tax": 33,
"line_items": [
{
"id": "sample string 1",
"date_from": 2,
"date_to": 3,
"unit_amount": 4,
"quantity": 5,
"amount": 6,
"pricing_model": "sample string 7",
"is_taxed": true,
"tax_amount": 9,
"unit_amount_in_decimal": "sample string 10",
"quantity_in_decimal": "sample string 11",
"amount_in_decimal": "sample string 12",
"object": "sample string 13",
"subscription_id": "sample string 14",
"customer_id": "sample string 15",
"description": "sample string 16",
"entity_type": "sample string 17",
"entity_id": "sample string 18",
"tax_exempt_reason": "sample string 19",
"discount_amount": 20,
"item_level_discount_amount": 21
},
{
"id": "sample string 1",
"date_from": 2,
"date_to": 3,
"unit_amount": 4,
"quantity": 5,
"amount": 6,
"pricing_model": "sample string 7",
"is_taxed": true,
"tax_amount": 9,
"unit_amount_in_decimal": "sample string 10",
"quantity_in_decimal": "sample string 11",
"amount_in_decimal": "sample string 12",
"object": "sample string 13",
"subscription_id": "sample string 14",
"customer_id": "sample string 15",
"description": "sample string 16",
"entity_type": "sample string 17",
"entity_id": "sample string 18",
"tax_exempt_reason": "sample string 19",
"discount_amount": 20,
"item_level_discount_amount": 21
}
],
"sub_total": 34,
"linked_payments": [
{},
{}
],
"applied_credits": [
{},
{}
],
"adjustment_credit_notes": [
{},
{}
],
"issued_credit_notes": [
{},
{}
],
"linked_orders": [
{},
{}
],
"dunning_attempts": [
{},
{}
],
"billing_address": {
"first_name": "sample string 1",
"last_name": "sample string 2",
"company": "sample string 3",
"validation_status": "sample string 4",
"object": "sample string 5"
},
"notes": {
"note": "sample string 1"
},
"business_entity_id": "sample string 35",
"IsSuccess": true,
"StatusCode": "sample string 37",
"ResponseBody": "sample string 38",
"StatusMessage": "sample string 39"
}
},
"event_type": "sample string 7",
"webhook_status": "sample string 8",
"method": "sample string 9",
"web_log_id": 10
}
application/xml, text/xml
Sample:
<GlobalRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GMWReceiverInterface.Core.ApiClasses">
<api_version>sample string 6</api_version>
<content>
<customer>
<IsSuccess>true</IsSuccess>
<ResponseBody>sample string 38</ResponseBody>
<StatusCode>sample string 37</StatusCode>
<StatusMessage>sample string 39</StatusMessage>
<allow_direct_debit>true</allow_direct_debit>
<auto_collection>sample string 5</auto_collection>
<card_status>sample string 14</card_status>
<cf_alt_email>sample string 32</cf_alt_email>
<cf_bankruptcy_notice_received_date>sample string 34</cf_bankruptcy_notice_received_date>
<cf_customer_number>sample string 21</cf_customer_number>
<cf_do_not_call>sample string 27</cf_do_not_call>
<cf_do_not_email>sample string 28</cf_do_not_email>
<cf_middle_initial>sample string 30</cf_middle_initial>
<cf_mobile_number>sample string 23</cf_mobile_number>
<cf_opt_in_out_date>sample string 33</cf_opt_in_out_date>
<cf_outstanding_balance>sample string 35</cf_outstanding_balance>
<cf_paperless_billing>sample string 29</cf_paperless_billing>
<cf_promise_to_pay_date>sample string 31</cf_promise_to_pay_date>
<cf_region>sample string 24</cf_region>
<cf_sub_region>sample string 26</cf_sub_region>
<cf_subsidiary>sample string 22</cf_subsidiary>
<cf_super_region>sample string 25</cf_super_region>
<created_at>8</created_at>
<deleted>true</deleted>
<email>sample string 4</email>
<excess_payments>18</excess_payments>
<first_name>sample string 2</first_name>
<id>sample string 1</id>
<last_name>sample string 3</last_name>
<net_term_days>6</net_term_days>
<object>sample string 13</object>
<preferred_currency_code>sample string 20</preferred_currency_code>
<primary_payment_source_id>sample string 15</primary_payment_source_id>
<promotional_credits>16</promotional_credits>
<refundable_credits>17</refundable_credits>
<resource_version>11</resource_version>
<taxability>sample string 9</taxability>
<unbilled_charges>19</unbilled_charges>
<updated_at>10</updated_at>
</customer>
<invoice>
<IsSuccess>true</IsSuccess>
<ResponseBody>sample string 38</ResponseBody>
<StatusCode>sample string 37</StatusCode>
<StatusMessage>sample string 39</StatusMessage>
<adjustment_credit_notes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
</adjustment_credit_notes>
<amount_adjusted>13</amount_adjusted>
<amount_due>16</amount_due>
<amount_paid>12</amount_paid>
<amount_to_collect>23</amount_to_collect>
<applied_credits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
</applied_credits>
<base_currency_code>sample string 28</base_currency_code>
<billing_address>
<company>sample string 3</company>
<first_name>sample string 1</first_name>
<last_name>sample string 2</last_name>
<object>sample string 5</object>
<validation_status>sample string 4</validation_status>
</billing_address>
<business_entity_id>sample string 35</business_entity_id>
<channel>sample string 32</channel>
<credits_applied>15</credits_applied>
<currency_code>sample string 27</currency_code>
<customer_id>sample string 2</customer_id>
<date>7</date>
<deleted>true</deleted>
<due_date>8</due_date>
<dunning_attempts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
</dunning_attempts>
<dunning_status>sample string 17</dunning_status>
<exchange_rate>10.1</exchange_rate>
<first_invoice>true</first_invoice>
<generated_at>29</generated_at>
<has_advance_charges>true</has_advance_charges>
<id>sample string 1</id>
<is_gifted>true</is_gifted>
<issued_credit_notes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
</issued_credit_notes>
<line_items>
<LineItems>
<amount>6</amount>
<amount_in_decimal>sample string 12</amount_in_decimal>
<customer_id>sample string 15</customer_id>
<date_from>2</date_from>
<date_to>3</date_to>
<description>sample string 16</description>
<discount_amount>20</discount_amount>
<entity_id>sample string 18</entity_id>
<entity_type>sample string 17</entity_type>
<id>sample string 1</id>
<is_taxed>true</is_taxed>
<item_level_discount_amount>21</item_level_discount_amount>
<object>sample string 13</object>
<pricing_model>sample string 7</pricing_model>
<quantity>5</quantity>
<quantity_in_decimal>sample string 11</quantity_in_decimal>
<subscription_id>sample string 14</subscription_id>
<tax_amount>9</tax_amount>
<tax_exempt_reason>sample string 19</tax_exempt_reason>
<unit_amount>4</unit_amount>
<unit_amount_in_decimal>sample string 10</unit_amount_in_decimal>
</LineItems>
<LineItems>
<amount>6</amount>
<amount_in_decimal>sample string 12</amount_in_decimal>
<customer_id>sample string 15</customer_id>
<date_from>2</date_from>
<date_to>3</date_to>
<description>sample string 16</description>
<discount_amount>20</discount_amount>
<entity_id>sample string 18</entity_id>
<entity_type>sample string 17</entity_type>
<id>sample string 1</id>
<is_taxed>true</is_taxed>
<item_level_discount_amount>21</item_level_discount_amount>
<object>sample string 13</object>
<pricing_model>sample string 7</pricing_model>
<quantity>5</quantity>
<quantity_in_decimal>sample string 11</quantity_in_decimal>
<subscription_id>sample string 14</subscription_id>
<tax_amount>9</tax_amount>
<tax_exempt_reason>sample string 19</tax_exempt_reason>
<unit_amount>4</unit_amount>
<unit_amount_in_decimal>sample string 10</unit_amount_in_decimal>
</LineItems>
</line_items>
<linked_orders xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
</linked_orders>
<linked_payments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
</linked_payments>
<net_term_days>9</net_term_days>
<new_sales_amount>25</new_sales_amount>
<notes>
<note>sample string 1</note>
</notes>
<object>sample string 21</object>
<price_type>sample string 6</price_type>
<recurring>true</recurring>
<resource_version>19</resource_version>
<round_off_amount>24</round_off_amount>
<status>sample string 5</status>
<sub_total>34</sub_total>
<subscription_id>sample string 3</subscription_id>
<tax>33</tax>
<term_finalized>true</term_finalized>
<total>11</total>
<updated_at>18</updated_at>
<write_off_amount>14</write_off_amount>
</invoice>
<subscription>
<IsSuccess>true</IsSuccess>
<ResponseBody>sample string 62</ResponseBody>
<StatusCode>sample string 61</StatusCode>
<StatusMessage>sample string 63</StatusMessage>
<activated_at>18</activated_at>
<base_currency_code>sample string 33</base_currency_code>
<billing_period>6</billing_period>
<billing_period_unit>sample string 7</billing_period_unit>
<business_entity_id>sample string 23</business_entity_id>
<cancel_reason_code>sample string 34</cancel_reason_code>
<cancelled_at>19</cancelled_at>
<cf_cas_codes>sample string 44</cf_cas_codes>
<cf_cas_codes_id>sample string 45</cf_cas_codes_id>
<cf_claim_date>sample string 37</cf_claim_date>
<cf_is_stripe>true</cf_is_stripe>
<cf_mac_address>sample string 42</cf_mac_address>
<cf_refresh>true</cf_refresh>
<cf_refresh_status_message>sample string 55</cf_refresh_status_message>
<cf_region_code>sample string 43</cf_region_code>
<cf_service_internal_id>sample string 47</cf_service_internal_id>
<cf_sku_id>sample string 40</cf_sku_id>
<cf_smartcard>sample string 41</cf_smartcard>
<cf_stb_type_id>sample string 46</cf_stb_type_id>
<cf_tve_code_to_change>sample string 38</cf_tve_code_to_change>
<cf_tve_codes>sample string 36</cf_tve_codes>
<cf_tve_email_add_non_stripe>sample string 58</cf_tve_email_add_non_stripe>
<cf_tve_email_address_stripe>sample string 59</cf_tve_email_address_stripe>
<cf_tve_expiry_date>sample string 56</cf_tve_expiry_date>
<cf_tve_plan>sample string 57</cf_tve_plan>
<cf_unclaimed_tve_code_1>sample string 50</cf_unclaimed_tve_code_1>
<cf_unclaimed_tve_code_2>sample string 51</cf_unclaimed_tve_code_2>
<cf_unclaimed_tve_code_3>sample string 52</cf_unclaimed_tve_code_3>
<cf_unclaimed_tve_code_4>sample string 53</cf_unclaimed_tve_code_4>
<cf_unclaimed_tve_codes>sample string 39</cf_unclaimed_tve_codes>
<cf_wallet_id>sample string 48</cf_wallet_id>
<cf_wallet_load>sample string 49</cf_wallet_load>
<created_at>16</created_at>
<currency_code>sample string 26</currency_code>
<current_term_end>14</current_term_end>
<current_term_start>13</current_term_start>
<customer_id>sample string 2</customer_id>
<deleted>true</deleted>
<due_invoices_count>27</due_invoices_count>
<due_since>28</due_since>
<exchange_rate>32.1</exchange_rate>
<has_scheduled_changes>true</has_scheduled_changes>
<id>sample string 1</id>
<mrr>30</mrr>
<next_billing_at>15</next_billing_at>
<object>sample string 25</object>
<pause_date>31</pause_date>
<plan_free_quantity>9</plan_free_quantity>
<plan_id>sample string 3</plan_id>
<plan_quantity>4</plan_quantity>
<plan_unit_price>5</plan_unit_price>
<remaining_billing_cycles>8</remaining_billing_cycles>
<resource_version>22</resource_version>
<started_at>17</started_at>
<status>sample string 10</status>
<subscription_items>
<SubscriptionItems>
<IsSuccess>true</IsSuccess>
<ResponseBody>sample string 14</ResponseBody>
<StatusCode>sample string 13</StatusCode>
<StatusMessage>sample string 15</StatusMessage>
<amount>7</amount>
<amount_in_decimal>sample string 8</amount_in_decimal>
<free_quantity>9</free_quantity>
<free_quantity_in_decimal>sample string 10</free_quantity_in_decimal>
<item_price_id>sample string 1</item_price_id>
<item_type>sample string 2</item_type>
<object>sample string 11</object>
<quantity>3</quantity>
<quantity_in_decimal>sample string 4</quantity_in_decimal>
<unit_price>5</unit_price>
<unit_price_in_decimal>sample string 6</unit_price_in_decimal>
</SubscriptionItems>
<SubscriptionItems>
<IsSuccess>true</IsSuccess>
<ResponseBody>sample string 14</ResponseBody>
<StatusCode>sample string 13</StatusCode>
<StatusMessage>sample string 15</StatusMessage>
<amount>7</amount>
<amount_in_decimal>sample string 8</amount_in_decimal>
<free_quantity>9</free_quantity>
<free_quantity_in_decimal>sample string 10</free_quantity_in_decimal>
<item_price_id>sample string 1</item_price_id>
<item_type>sample string 2</item_type>
<object>sample string 11</object>
<quantity>3</quantity>
<quantity_in_decimal>sample string 4</quantity_in_decimal>
<unit_price>5</unit_price>
<unit_price_in_decimal>sample string 6</unit_price_in_decimal>
</SubscriptionItems>
</subscription_items>
<total_dues>29.1</total_dues>
<trial_end>12</trial_end>
<trial_start>11</trial_start>
<updated_at>20</updated_at>
</subscription>
</content>
<event_type>sample string 7</event_type>
<id>sample string 1</id>
<method>sample string 9</method>
<object>sample string 5</object>
<occurred_at>2</occurred_at>
<source>sample string 3</source>
<user>sample string 4</user>
<web_log_id>10</web_log_id>
<webhook_status>sample string 8</webhook_status>
</GlobalRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |