add returnPath to loyalty docs

botisimo · May 23, 2022 · 98fc47d · 98fc47d
1 parent bc2922b
commit 98fc47d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/docs/loyalty/documentation/authentication.rst b/docs/loyalty/documentation/authentication.rst
@@ -21,6 +21,7 @@ interval    string   The billing interval. Should be ``month`` or ``year``
 password    string
 tags        number[] Array of Tag IDs
 membership  number   Membership ID
+returnPath  [string] The URL path to return to after stripe checkout
 =========== ======== ======================================================
 
 .. code-block:: js
@@ -32,6 +33,7 @@ membership  number   Membership ID
       dateOfBirth: '12/25/1990',
       membership: 1,
       tags: [1, 2, 3, 4],
+      returnPath: '/'
    });
 
 Response

diff --git a/docs/loyalty/documentation/billing.rst b/docs/loyalty/documentation/billing.rst
@@ -21,14 +21,16 @@ Field       Type     Description
 =========== ======== =====================================================
 interval    string   The billing interval. Should be ``month`` or ``year``
 membership  number   Membership ID
+returnPath  [string] The URL path to return to after stripe checkout
 =========== ======== =====================================================
 
 .. code-block:: js
 
    const response = await axios.get('https://botisimo.com/api/v1/loyalty/:team/billing/update', {
       params: {
          interval: 'month',
-         membership: 1
+         membership: 1,
+         returnPath: '/billing'
       },
       headers: {
          'x-user-auth-token': 'xxxxxxx',
@@ -64,14 +66,16 @@ Field       Type     Description
 =========== ======== =====================================================
 interval    string   The billing interval. Should be ``month`` or ``year``
 membership  number   Membership ID
+returnPath  [string] The URL path to return to after stripe checkout
 =========== ======== =====================================================
 
 .. code-block:: js
 
    const response = await axios.get('https://botisimo.com/api/v1/loyalty/:team/billing/confirm', {
       params: {
          interval: 'month',
-         membership: 1
+         membership: 1,
+         returnPath: '/billing'
       },
       headers: {
          'x-user-auth-token': 'xxxxxxx',
@@ -98,12 +102,15 @@ Request
 =========== ======== ==========================================
 Field       Type     Description
 =========== ======== ==========================================
-\-          \-       \-
+returnPath  [string] The URL path to return to after stripe checkout
 =========== ======== ==========================================
 
 .. code-block:: js
 
    const response = await axios.get('https://botisimo.com/api/v1/loyalty/:team/billing/manage', {
+      params: {
+         returnPath: '/billing'
+      },
       headers: {
          'x-user-auth-token': 'xxxxxxx',
       },