Merge pull request #124 from chargify/api-referral-codes

Documenting API for referral code validation
chargify · Nov 17, 2015 · 9d5c6fb · 9d5c6fb
2 parents 40d8f8f + fbd85ec
commit 9d5c6fb
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/doculab/docs/api-coupons.textile b/doculab/docs/api-coupons.textile
@@ -110,7 +110,7 @@ Response: The coupon resource
 
 h2. Validating a Coupon via the API
 
-You can verify if an specific coupon code is valid using the @validate@ method. This method is useful for validating coupon codes that are entered by a customer.  If the coupon is found and is valid, the coupon will be returned with a 200 status code.
+You can verify if a specific coupon code is valid using the @validate@ method. This method is useful for validating coupon codes that are entered by a customer.  If the coupon is found and is valid, the coupon will be returned with a 200 status code.
 
 h3. Validate
 

diff --git a/doculab/docs/api-referral-codes.textile b/doculab/docs/api-referral-codes.textile
@@ -0,0 +1,11 @@
+h2. Validating Referral Codes via the API
+
+You can verify if a referral code is valid using the @validate@ method. This method is useful for validating referral codes that are entered by a customer.
+
+h3. Validate
+
+URL: @https://<subdomain>.chargify.com/referral_codes/validate.<format>?code=<referral_code>@
+Method: @GET@
+Required Parameters: code
+Response: If the referral code is valid the status code will be 200 and the referral code will be returned. If the referral code is invalid, a 404 response will be returnd.
+
diff --git a/doculab/meta/table_of_contents.rb b/doculab/meta/table_of_contents.rb
@@ -141,6 +141,7 @@
     page "API: Product Families"
     page "API: Products"
     page "API: Quantity Component Allocations", :permalink => "api-quantity-allocations"
+    page "API: Referral Codes"
     page "API: Refunds"
     page "API: Refunds - External", :permalink => "api-refunds-external"
     page "API: Renewal Preview"