| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| v:0.6.0:docs:api [2010/09/16 03:15] – adding pagination_start details foxyluke | v:0.6.0:docs:api [2017/04/26 07:02] (current) – external edit 127.0.0.1 |
|---|
| * ''subscription_get'' (v060+) | * ''subscription_get'' (v060+) |
| * ''subscription_cancel'' (v060+) Sets the ''sub_enddate'' to the next day, effectively canceling the subscription. | * ''subscription_cancel'' (v060+) Sets the ''sub_enddate'' to the next day, effectively canceling the subscription. |
| * ''subscription_modify'' (v070+) Let's you modify the any of the following subscription values: ''start_date'', ''end_date'', ''next_transaction_date'', ''frequency'', ''past_due_amount'', ''is_active'', ''transaction_template''. For more details on the ''transaction_template'' format, see this XSD: http://admin.foxycart.com/v/0.7.0/xsd/transaction_template.xsd | * ''subscription_modify'' (v070+) Lets you modify any of the following subscription values: ''start_date'', ''end_date'', ''next_transaction_date'', ''frequency'', ''past_due_amount'', ''is_active'', ''transaction_template''. For more details on the ''transaction_template'' format, see this XSD: http://admin.foxycart.com/v/0.7.0/xsd/transaction_template.xsd |
| == Required Fields == | == Required Fields == |
| * ''sub_token'', can be either the token itself or the complete URL | * ''sub_token'', can be either the token itself or the complete URL |
| You can always use [[http://curl.haxx.se/docs/httpscripting.html|CURL]] to test the API. Here is an example command line CURL request: | You can always use [[http://curl.haxx.se/docs/httpscripting.html|CURL]] to test the API. Here is an example command line CURL request: |
| <code> | <code> |
| curl -d "api_token=PUT_YOUR_API_KEY_HERE&api_action=customer_get&customer_email=john.doe@example.com" https://example.foxycart.tld/api | curl -d "api_token=PUT_YOUR_API_KEY_HERE&api_action=customer_get&customer_email=john.doe@example.com" https://example.foxycart.com/api |
| </code> | </code> |
| You'd obviously need to insert your own values in that call, but it's provided here for reference. Using CURL can be handy if you just want to get a customer ID quickly, or test to ensure data is being returned as expected. | You'd obviously need to insert your own values in that call, but it's provided here for reference. Using CURL can be handy if you just want to get a customer ID quickly, or test to ensure data is being returned as expected. |
