You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -13,8 +13,8 @@ Maxio Advanced Billing (formerly Chargify API) can be integrated with many envir
13
13
14
14
Maxio Advanced Billing has compiled a [testing guide](https://chargify.zendesk.com/hc/en-us/articles/4407904658587) that covers a list of important factors to consider while in the testing phase. Here's a high-level overiew of what's covered in our testing guide:
15
15
16
-
+ Test credit card basics
17
-
+ Test site limits
16
+
+ Test credit card basics
17
+
+ Test site limits
18
18
+ Live mode versus test mode
19
19
20
20
We strongly suggest reading over the testing guide, as well as the entire set of application-based documentation to aid in your discovery of the product.
@@ -33,22 +33,22 @@ Access to our Technical Specialist team for API support is currently limited to
33
33
34
34
But don’t worry! There are quite a few options to help you get the answers you need:
35
35
36
-
-[Read our documentation for developers](https://developers.chargify.com/docs/developer-docs/ZG9jOjM0NjA3MQ-overview)
37
-
- Explore the endpoints of our API Documentation
38
-
-[Watch our videos and tutorials](https://chargify.com/tutorials)
36
+
-[Read our documentation for developers](https://developers.chargify.com/docs/developer-docs/ZG9jOjM0NjA3MQ-overview)
37
+
- Explore the endpoints of our API Documentation
38
+
-[Watch our videos and tutorials](https://chargify.com/tutorials)
39
39
-[Check out the Chargify tag on Stack Overflow](http://stackoverflow.com/questions/tagged/chargify)
40
40
41
41
### API Overview
42
42
43
43
The Chargify API allows you to interact with our system programmatically from your own application. Using the API you interact with Resources such as:
44
44
45
-
- Products
46
-
- Subscriptions
47
-
- Customers
45
+
- Products
46
+
- Subscriptions
47
+
- Customers
48
48
- etc.
49
49
50
-
The API attempts to conform to the [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) design principles.
51
-
You interact with the resources exposed via the API by accessing resource collection and element URIs using the HTTP verbs (GET, POST, PUT, and DELETE).
50
+
The API attempts to conform to the [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) design principles.
51
+
You interact with the resources exposed via the API by accessing resource collection and element URIs using the HTTP verbs (GET, POST, PUT, and DELETE).
52
52
Chargify accepts and returns both JSON and XML data via the API.
53
53
54
54
You’ll likely need access to a web developer or programmer (if you’re not one) to get the most use out of the API.
@@ -127,10 +127,10 @@ If you see a "Could not resolve host" error, double check that the url is correc
127
127
128
128
We consider the following changes to be backwards compatible and may make them without advance notice:
129
129
130
-
+ Adding new API endpoints, or adding new attributes in the responses of existing endpoints
131
-
+ Adding new optional parameters to be sent to existing API endpoints
132
-
+ Adding new fields to exported data
133
-
+ Changing the type or length of any of the ID attributes
130
+
+ Adding new API endpoints, or adding new attributes in the responses of existing endpoints
131
+
+ Adding new optional parameters to be sent to existing API endpoints
132
+
+ Adding new fields to exported data
133
+
+ Changing the type or length of any of the ID attributes
134
134
+ For example, most IDs are currently integers, but you should not assume that this will always be the case.
135
135
136
136
In addition, you should not depend on the order of attributes within the API response as this may change.
There are a few scenarios that may end up in causing an API request to be blocked even with correct credentials.
152
+
There are a few scenarios that may end up in causing an API request to be blocked even with correct credentials.
153
153
**Please note:** All relevant API requests will be blocked if any of the below conditions are true. These limitations also apply to [Chargify Direct](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDE3-introduction).
154
154
155
155
Those scenarios are as follows:
156
156
157
-
- Your Chargify subscription is canceled.
158
-
- Your Chargify trial has reached an end.
159
-
- The site you're making a request for is in the process of ["clearing site data"](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405428327309)
160
-
-_Note: any API request for another site that is in a good state will NOT be blocked_
161
-
- The site you're making a request for has been deleted.
157
+
- Your Chargify subscription is canceled.
158
+
- Your Chargify trial has reached an end.
159
+
- The site you're making a request for is in the process of ["clearing site data"](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405428327309)
160
+
-_Note: any API request for another site that is in a good state will NOT be blocked_
161
+
- The site you're making a request for has been deleted.
162
162
-_Note: any API request for another site that is in a good state will NOT be blocked_
163
163
164
164
Read more about your Chargify subscription [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405430043149-Advanced-Billing-Subscription#advanced-billing-subscription-0-0)
@@ -169,42 +169,42 @@ The request will fail with a `422` http status code. The response will also incl
169
169
170
170
- If your Chargify subscription is canceled:
171
171
172
-
```json
173
-
{
174
-
"errors"=> [
175
-
[0] "Your Chargify account has been canceled. Please contact support@chargify.com to reactivate."
176
-
]
177
-
}
172
+
```json
173
+
{
174
+
"errors"=> [
175
+
[0] "Your Chargify account has been canceled. Please contact support@chargify.com to reactivate."
176
+
]
177
+
}
178
178
```
179
179
180
180
- If your Chargify trial has reached and end and you attempted to make an API request, the response body will look like:
181
181
182
-
```json
183
-
{
184
-
"errors"=> [
185
-
[0] "Your trial has ended, please contact sales."
186
-
]
187
-
}
182
+
```json
183
+
{
184
+
"errors"=> [
185
+
[0] "Your trial has ended, please contact sales."
186
+
]
187
+
}
188
188
```
189
189
190
190
- If the site you're making a request for is in the process of ["clearing site data"](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405428327309):
191
191
192
-
```json
193
-
{
194
-
"errors"=> [
195
-
[0] "Site data clearing is in progress. Please try later."
196
-
]
197
-
}
192
+
```json
193
+
{
194
+
"errors"=> [
195
+
[0] "Site data clearing is in progress. Please try later."
196
+
]
197
+
}
198
198
```
199
199
200
200
- If the site you're making a request for has been deleted:
201
201
202
-
```json
203
-
{
204
-
"errors"=> [
205
-
[0] "This site has been deleted."
206
-
]
207
-
}
202
+
```json
203
+
{
204
+
"errors"=> [
205
+
[0] "This site has been deleted."
206
+
]
207
+
}
208
208
```
209
209
210
210
### Secure Applications
@@ -217,14 +217,14 @@ Instead you will need to take care to tokenize sensitive information by using [C
217
217
218
218
If you attempt to make a Chargify API request directly from the customer's browser, you may see an error such as:
219
219
220
-
```
221
-
Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource.
220
+
```
221
+
Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource.
222
222
```
223
223
224
224
or
225
225
226
-
```
227
-
Origin 'https://example.com' is therefore not allowed access.` `The response had HTTP status code 404.
226
+
```
227
+
Origin 'https://example.com' is therefore not allowed access.` `The response had HTTP status code 404.
228
228
```
229
229
230
230
This is an error message indicating that Cross-Origin Resource Sharing (CORS) is not enabled on the Chargify server.
@@ -257,13 +257,13 @@ It is up to API consumers to parse the string into a decimal number representati
257
257
258
258
##### Relationship Invoicing Summary
259
259
260
-
+ If your site **is** using relationship invoicing, you may only use the methods described in this section for working with invoices.
261
-
262
-
+ If your site is **not** using relationship invoicing, please use the legacy invoice methods:
0 commit comments