changeOffer

The changeOffer postback is used to inform that a subscription has changed from one offer to another, f.ex. from a monthly to a yearly billing schedule or from a quarterly to a monthly.

Request parameters

Parameter

Data type

Description

callback

string

Specifies the action for this request, which in this case is "changeOffer".

subscription_id

numeric

Vendo's subscription identifier.
Example: 123456789

offer_id

numeric

Vendo internal offer id for the new offer.
Example: 12345

offer_identifier

string

Your offer identifier for the new offer.
Example: yearly99

change_type

string

Specifies the change type: upgrade or downgrade

is_test

boolean

Whether or not this request is related to a test transaction or subscription.
0 for no (real transaction)
1 for yes (test transaction)

Your server must reply with one of these response formats:

OK (Response code 1)

Reply with this if the request was received successfully.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<postbackResponse>  
 <changeOffer>       
  <code>1</code> 
 </changeOffer>
</postbackResponse>

ERROR (Response code 2)

Reply with this if you encountered an unexpected problem with the request.

Include a custom error message with your message for tracing/debugging. Make sure this error message is meaningful because it is stored to a logfile for later debugging.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<postbackResponse> 
 <changeOffer>  
  <code>2</code>  
  <errorMessage>Custom error message</errorMessage> 
 </changeOffer>
</postbackResponse>

🚧

Note for NATS users

NATS v3 doesn't support this postback. If you run NATS v3, you have to create a script to handle it. Contact Vendo support for more information.


Did this page help you?