Nest Changelog

1.24.7 PRE

4/18/2023

1.24.8

4/19/2023

11 changed endpoints

POST /subscriptions/{id}/quote

create a new subscription in stripe from shopify order, optionally applies a redemption code

Response Body
{
  data: {
    campaign?: {
      createdBy?: {
        id?: number,
      },
      dateCreated?: number,
      dateExpires?: number,
      delayBillingDays?: number,
      guid?: string,
      name?: string,
      partner?: {
        id?: number,
        name?: string,
      },
      utmCampaign?: string,
      utmSource?: string,
    },
    dateFirstBilling?: number,
    plan?: {
      basePrice?: {
        currency?: {
          code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
          scale?: number,
        },
        value?: number,
      },
      benefits?: List<{
        text?: string,
      }>,
      billingProvider?: {
        id?: number,
        metadata?: {
          avaTaxIntegration?: bool,
        },
        name?: string,
        organizationCode?: string,
        priceCode?: string,
        productCode?: string,
        type?: 'stripe' | 'apple' | 'google' | 'amazon',
      },
      country?: {
        code?: string,
        currency?: {
          code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
          scale?: number,
        },
        name?: string,
      },
      createdBy?: {
        id?: number,
      },
      dateCreated?: number,
      dateUpdated?: number,
      defaultTrial?: {
        units?: 'day',
        value?: number,
      },
      delayBillingDays?: number,
      description?: string,
      emailTemplateId?: number,
      family?: {
        brands?: List<'echelon' | 'fitnation' | 'fitquest'>,
        code?: 'spinco' | 'premier' | 'select' | 'flex' | 'fitpass' | 'lite' | 'choice' | 'free',
        type?: 'connected' | 'disconnected',
      },
      frequency?: {
        units?: 'month',
        value?: number,
      },
      frequencyDays?: number,
      id?: number,
      name?: string,
      sku?: string,
      sortOrder?: number,
      source?: {
        accountId?: string,
        productId?: string,
        type?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
      },
      tags?: List<'humana' | 'gympass' | 'addon' | 'amazon' | 'popular' | 'directPurchase' | 'csOnly' | 'displayInAdmin'>,
      updatedBy?: {
        id?: number,
      },
    },
    redemptionCode?: {
      batchGuid?: string,
      campaignCode?: string,
      code?: string,
      createdBy?: {
        id?: number,
      },
      dateCreated?: number,
-     delayBillingDays?: number,



      eligibilityRequirements?: record,
-     plans?: List<{






















































































































        id?: number,
      }>,
      redeemedBy?: {
        id?: number,
      },
      referenceNumber?: string,
      retailer?: {
        bundleDays: number,
        id?: number,
        name: string,
      },
      serialNumber?: string,
      status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
-     stripeCoupon?: string,



      subscription?: {
        id?: number,
      },
    },
  },
}

POST /subscriptions/{id}/quote

create a new subscription in stripe from shopify order, optionally applies a redemption code

Response Body
{
  data: {
    campaign?: {
      createdBy?: {
        id?: number,
      },
      dateCreated?: number,
      dateExpires?: number,
      delayBillingDays?: number,
      guid?: string,
      name?: string,
      partner?: {
        id?: number,
        name?: string,
      },
      utmCampaign?: string,
      utmSource?: string,
    },
    dateFirstBilling?: number,
    plan?: {
      basePrice?: {
        currency?: {
          code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
          scale?: number,
        },
        value?: number,
      },
      benefits?: List<{
        text?: string,
      }>,
      billingProvider?: {
        id?: number,
        metadata?: {
          avaTaxIntegration?: bool,
        },
        name?: string,
        organizationCode?: string,
        priceCode?: string,
        productCode?: string,
        type?: 'stripe' | 'apple' | 'google' | 'amazon',
      },
      country?: {
        code?: string,
        currency?: {
          code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
          scale?: number,
        },
        name?: string,
      },
      createdBy?: {
        id?: number,
      },
      dateCreated?: number,
      dateUpdated?: number,
      defaultTrial?: {
        units?: 'day',
        value?: number,
      },
      delayBillingDays?: number,
      description?: string,
      emailTemplateId?: number,
      family?: {
        brands?: List<'echelon' | 'fitnation' | 'fitquest'>,
        code?: 'spinco' | 'premier' | 'select' | 'flex' | 'fitpass' | 'lite' | 'choice' | 'free',
        type?: 'connected' | 'disconnected',
      },
      frequency?: {
        units?: 'month',
        value?: number,
      },
      frequencyDays?: number,
      id?: number,
      name?: string,
      sku?: string,
      sortOrder?: number,
      source?: {
        accountId?: string,
        productId?: string,
        type?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
      },
      tags?: List<'humana' | 'gympass' | 'addon' | 'amazon' | 'popular' | 'directPurchase' | 'csOnly' | 'displayInAdmin'>,
      updatedBy?: {
        id?: number,
      },
    },
    redemptionCode?: {
      batchGuid?: string,
      campaignCode?: string,
      code?: string,
      createdBy?: {
        id?: number,
      },
      dateCreated?: number,



+     delayBillingDays: number,
      eligibilityRequirements?: record,



+     offer?: {
+       billingProvider?: {
+         id?: number,
+         metadata?: {
+           avaTaxIntegration?: bool,
+         },
+         name?: string,
+         organizationCode?: string,
+         type?: 'stripe' | 'apple' | 'google' | 'amazon',
+       },
+       country?: {
+         code?: string,
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         name?: string,
+       },
+       createdBy?: {
+         id?: number,
+       },
+       dateCreated?: number,
+       delayBilling?: {
+         days?: number,
+         text?: string,
+         type?: 'trial' | 'bundle',
+       },
+       frequencyDays?: number,
+       guid?: string,
+       image?: {
+         default: string,
+         large: string,
+         medium: string,
+         small: string,
+         url?: string,
+       },
+       introductory?: {
+         days?: number,
+         price?: number,
+         stripeCouponId?: string,
+         text?: string,
+       },
+       name?: string,
+       plan?: {
+         basePrice?: {
+           currency?: {
+             code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+             scale?: number,
+           },
+           value?: number,
+         },
+         benefits?: List<{
+           text?: string,
+         }>,
+         billingProvider?: {
+           id?: number,
+           metadata?: {
+             avaTaxIntegration?: bool,
+           },
+           name?: string,
+           organizationCode?: string,
+           priceCode?: string,
+           productCode?: string,
+           type?: 'stripe' | 'apple' | 'google' | 'amazon',
+         },
+         country?: {
+           code?: string,
+           currency?: {
+             code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+             scale?: number,
+           },
+           name?: string,
+         },
+         createdBy?: {
+           id?: number,
+         },
+         dateCreated?: number,
+         dateUpdated?: number,
+         defaultTrial?: {
+           units?: 'day',
+           value?: number,
+         },
+         delayBillingDays?: number,
+         description?: string,
+         emailTemplateId?: number,
+         family?: {
+           brands?: List<'echelon' | 'fitnation' | 'fitquest'>,
+           code?: 'spinco' | 'premier' | 'select' | 'flex' | 'fitpass' | 'lite' | 'choice' | 'free',
+           type?: 'connected' | 'disconnected',
+         },
+         frequency?: {
+           units?: 'month',
+           value?: number,
+         },
+         frequencyDays?: number,
+         id?: number,
+         name?: string,
+         sku?: string,
+         sortOrder?: number,
+         source?: {
+           accountId?: string,
+           productId?: string,
+           type?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
+         },
+         tags?: List<'humana' | 'gympass' | 'addon' | 'amazon' | 'popular' | 'directPurchase' | 'csOnly' | 'displayInAdmin'>,
+         updatedBy?: {
+           id?: number,
+         },
+       },
+       recurring?: {
+         price?: number,
+         stripePriceId?: string,
+       },
+       status?: 'draft' | 'published',
+     },
+     plans: List<{
        id?: number,
      }>,
      redeemedBy?: {
        id?: number,
      },
      referenceNumber?: string,
      retailer?: {
        bundleDays: number,
        id?: number,
        name: string,
      },
      serialNumber?: string,
      status?: 'inactive' | 'active' | 'redeemed' | 'deleted',



+     stripeCoupon: string,
      subscription?: {
        id?: number,
      },
    },
  },
}

GET /redemption-codes

Get a list of redemption codes

Response Body
{
  data: List<{
    batchGuid?: string,
    campaignCode?: string,
    code?: string,
    createdBy?: {
      id?: number,
    },
    dateCreated?: number,
-   delayBillingDays?: number,



    eligibilityRequirements?: record,
-   plans?: List<{






















































































































      id?: number,
    }>,
    redeemedBy?: {
      id?: number,
    },
    referenceNumber?: string,
    retailer?: {
      bundleDays: number,
      id?: number,
      name: string,
    },
    serialNumber?: string,
    status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
-   stripeCoupon?: string,



    subscription?: {
      id?: number,
    },
  }>,
  pagination: {
    page?: number,
    skip?: number,
    take?: number,
    total?: {
      pages?: number,
      rows?: number,
    },
  },
}

GET /redemption-codes

Get a list of redemption codes

Response Body
{
  data: List<{
    batchGuid?: string,
    campaignCode?: string,
    code?: string,
    createdBy?: {
      id?: number,
    },
    dateCreated?: number,



+   delayBillingDays: number,
    eligibilityRequirements?: record,



+   offer?: {
+     billingProvider?: {
+       id?: number,
+       metadata?: {
+         avaTaxIntegration?: bool,
+       },
+       name?: string,
+       organizationCode?: string,
+       type?: 'stripe' | 'apple' | 'google' | 'amazon',
+     },
+     country?: {
+       code?: string,
+       currency?: {
+         code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+         scale?: number,
+       },
+       name?: string,
+     },
+     createdBy?: {
+       id?: number,
+     },
+     dateCreated?: number,
+     delayBilling?: {
+       days?: number,
+       text?: string,
+       type?: 'trial' | 'bundle',
+     },
+     frequencyDays?: number,
+     guid?: string,
+     image?: {
+       default: string,
+       large: string,
+       medium: string,
+       small: string,
+       url?: string,
+     },
+     introductory?: {
+       days?: number,
+       price?: number,
+       stripeCouponId?: string,
+       text?: string,
+     },
+     name?: string,
+     plan?: {
+       basePrice?: {
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         value?: number,
+       },
+       benefits?: List<{
+         text?: string,
+       }>,
+       billingProvider?: {
+         id?: number,
+         metadata?: {
+           avaTaxIntegration?: bool,
+         },
+         name?: string,
+         organizationCode?: string,
+         priceCode?: string,
+         productCode?: string,
+         type?: 'stripe' | 'apple' | 'google' | 'amazon',
+       },
+       country?: {
+         code?: string,
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         name?: string,
+       },
+       createdBy?: {
+         id?: number,
+       },
+       dateCreated?: number,
+       dateUpdated?: number,
+       defaultTrial?: {
+         units?: 'day',
+         value?: number,
+       },
+       delayBillingDays?: number,
+       description?: string,
+       emailTemplateId?: number,
+       family?: {
+         brands?: List<'echelon' | 'fitnation' | 'fitquest'>,
+         code?: 'spinco' | 'premier' | 'select' | 'flex' | 'fitpass' | 'lite' | 'choice' | 'free',
+         type?: 'connected' | 'disconnected',
+       },
+       frequency?: {
+         units?: 'month',
+         value?: number,
+       },
+       frequencyDays?: number,
+       id?: number,
+       name?: string,
+       sku?: string,
+       sortOrder?: number,
+       source?: {
+         accountId?: string,
+         productId?: string,
+         type?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
+       },
+       tags?: List<'humana' | 'gympass' | 'addon' | 'amazon' | 'popular' | 'directPurchase' | 'csOnly' | 'displayInAdmin'>,
+       updatedBy?: {
+         id?: number,
+       },
+     },
+     recurring?: {
+       price?: number,
+       stripePriceId?: string,
+     },
+     status?: 'draft' | 'published',
+   },
+   plans: List<{
      id?: number,
    }>,
    redeemedBy?: {
      id?: number,
    },
    referenceNumber?: string,
    retailer?: {
      bundleDays: number,
      id?: number,
      name: string,
    },
    serialNumber?: string,
    status?: 'inactive' | 'active' | 'redeemed' | 'deleted',



+   stripeCoupon: string,
    subscription?: {
      id?: number,
    },
  }>,
  pagination: {
    page?: number,
    skip?: number,
    take?: number,
    total?: {
      pages?: number,
      rows?: number,
    },
  },
}

PUT /redemption-codes

Create one or more redemption codes. Used for importing pre-generated codes.

Request Body
{
  campaignCode?: string,
  codes?: List<{
    code?: string,
    referenceNumber: string,
  }>,
- delayBillingDays?: number,



  eligibilityRequirements: record,
- planIds?: List<number>,






  retailerId?: number,
  status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
  stripeCoupon: string,
}

PUT /redemption-codes

Create one or more redemption codes. Used for importing pre-generated codes.

Request Body
{
  campaignCode?: string,
  codes?: List<{
    code?: string,
    referenceNumber: string,
  }>,



+ delayBillingDays: number,
  eligibilityRequirements: record,



+ offer: {
+   guid?: string,
+ },
+ planIds: List<number>,
  retailerId?: number,
  status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
  stripeCoupon: string,
}

PATCH /redemption-codes

Request Body
{
  data?: {
    campaignCode: string,
    delayBillingDays: number,
    eligibilityRequirements: record,





    plans: List<{
      id?: number,
    }>,
    redeemedBy: {
      id?: number,
    },
    referenceNumber: string,
    retailer: {
      id?: number,
    },
    serialNumber: string,
    status: 'inactive' | 'active' | 'redeemed' | 'deleted',
    stripeCoupon: string,
    subscription: {
      id?: number,
    },
  },
  where?: {
    batchGuid: string,
    campaignCode: string,
    codes: List<string>,
    prefix: string,
    retailerId: number,
  },
}

PATCH /redemption-codes

Request Body
{
  data?: {
    campaignCode: string,
    delayBillingDays: number,
    eligibilityRequirements: record,
+   offer: {
+     guid?: string,
+   },
    plans: List<{
      id?: number,
    }>,
    redeemedBy: {
      id?: number,
    },
    referenceNumber: string,
    retailer: {
      id?: number,
    },
    serialNumber: string,
    status: 'inactive' | 'active' | 'redeemed' | 'deleted',
    stripeCoupon: string,
    subscription: {
      id?: number,
    },
  },
  where?: {
    batchGuid: string,
    campaignCode: string,
    codes: List<string>,
    prefix: string,
    retailerId: number,
  },
}

GET /redemption-codes/{code}

Get a single Redemption Code

Response Body
{
  data: {
    batchGuid?: string,
    campaignCode?: string,
    code?: string,
    createdBy?: {
      id?: number,
    },
    dateCreated?: number,
-   delayBillingDays?: number,



    eligibilityRequirements?: record,
-   plans?: List<{






















































































































      id?: number,
    }>,
    redeemedBy?: {
      id?: number,
    },
    referenceNumber?: string,
    retailer?: {
      bundleDays: number,
      id?: number,
      name: string,
    },
    serialNumber?: string,
    status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
-   stripeCoupon?: string,



    subscription?: {
      id?: number,
    },
  },
}

GET /redemption-codes/{code}

Get a single Redemption Code

Response Body
{
  data: {
    batchGuid?: string,
    campaignCode?: string,
    code?: string,
    createdBy?: {
      id?: number,
    },
    dateCreated?: number,



+   delayBillingDays: number,
    eligibilityRequirements?: record,



+   offer?: {
+     billingProvider?: {
+       id?: number,
+       metadata?: {
+         avaTaxIntegration?: bool,
+       },
+       name?: string,
+       organizationCode?: string,
+       type?: 'stripe' | 'apple' | 'google' | 'amazon',
+     },
+     country?: {
+       code?: string,
+       currency?: {
+         code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+         scale?: number,
+       },
+       name?: string,
+     },
+     createdBy?: {
+       id?: number,
+     },
+     dateCreated?: number,
+     delayBilling?: {
+       days?: number,
+       text?: string,
+       type?: 'trial' | 'bundle',
+     },
+     frequencyDays?: number,
+     guid?: string,
+     image?: {
+       default: string,
+       large: string,
+       medium: string,
+       small: string,
+       url?: string,
+     },
+     introductory?: {
+       days?: number,
+       price?: number,
+       stripeCouponId?: string,
+       text?: string,
+     },
+     name?: string,
+     plan?: {
+       basePrice?: {
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         value?: number,
+       },
+       benefits?: List<{
+         text?: string,
+       }>,
+       billingProvider?: {
+         id?: number,
+         metadata?: {
+           avaTaxIntegration?: bool,
+         },
+         name?: string,
+         organizationCode?: string,
+         priceCode?: string,
+         productCode?: string,
+         type?: 'stripe' | 'apple' | 'google' | 'amazon',
+       },
+       country?: {
+         code?: string,
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         name?: string,
+       },
+       createdBy?: {
+         id?: number,
+       },
+       dateCreated?: number,
+       dateUpdated?: number,
+       defaultTrial?: {
+         units?: 'day',
+         value?: number,
+       },
+       delayBillingDays?: number,
+       description?: string,
+       emailTemplateId?: number,
+       family?: {
+         brands?: List<'echelon' | 'fitnation' | 'fitquest'>,
+         code?: 'spinco' | 'premier' | 'select' | 'flex' | 'fitpass' | 'lite' | 'choice' | 'free',
+         type?: 'connected' | 'disconnected',
+       },
+       frequency?: {
+         units?: 'month',
+         value?: number,
+       },
+       frequencyDays?: number,
+       id?: number,
+       name?: string,
+       sku?: string,
+       sortOrder?: number,
+       source?: {
+         accountId?: string,
+         productId?: string,
+         type?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
+       },
+       tags?: List<'humana' | 'gympass' | 'addon' | 'amazon' | 'popular' | 'directPurchase' | 'csOnly' | 'displayInAdmin'>,
+       updatedBy?: {
+         id?: number,
+       },
+     },
+     recurring?: {
+       price?: number,
+       stripePriceId?: string,
+     },
+     status?: 'draft' | 'published',
+   },
+   plans: List<{
      id?: number,
    }>,
    redeemedBy?: {
      id?: number,
    },
    referenceNumber?: string,
    retailer?: {
      bundleDays: number,
      id?: number,
      name: string,
    },
    serialNumber?: string,
    status?: 'inactive' | 'active' | 'redeemed' | 'deleted',



+   stripeCoupon: string,
    subscription?: {
      id?: number,
    },
  },
}

PATCH /redemption-codes/{code}

Update an individual Redemption Code

Request Body
{
  campaignCode: string,
  delayBillingDays: number,
  eligibilityRequirements: record,





  plans: List<{
    id?: number,
  }>,
  redeemedBy: {
    id?: number,
  },
  referenceNumber: string,
  retailer: {
    id?: number,
  },
  serialNumber: string,
  status: 'inactive' | 'active' | 'redeemed' | 'deleted',
  stripeCoupon: string,
  subscription: {
    id?: number,
  },
}
Response Body
{
  data: {
    batchGuid?: string,
    campaignCode?: string,
    code?: string,
    createdBy?: {
      id?: number,
    },
    dateCreated?: number,
-   delayBillingDays?: number,



    eligibilityRequirements?: record,
-   plans?: List<{






















































































































      id?: number,
    }>,
    redeemedBy?: {
      id?: number,
    },
    referenceNumber?: string,
    retailer?: {
      bundleDays: number,
      id?: number,
      name: string,
    },
    serialNumber?: string,
    status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
-   stripeCoupon?: string,



    subscription?: {
      id?: number,
    },
  },
}

PATCH /redemption-codes/{code}

Update an individual Redemption Code

Request Body
{
  campaignCode: string,
  delayBillingDays: number,
  eligibilityRequirements: record,
+ offer: {
+   guid?: string,
+ },
  plans: List<{
    id?: number,
  }>,
  redeemedBy: {
    id?: number,
  },
  referenceNumber: string,
  retailer: {
    id?: number,
  },
  serialNumber: string,
  status: 'inactive' | 'active' | 'redeemed' | 'deleted',
  stripeCoupon: string,
  subscription: {
    id?: number,
  },
}
Response Body
{
  data: {
    batchGuid?: string,
    campaignCode?: string,
    code?: string,
    createdBy?: {
      id?: number,
    },
    dateCreated?: number,



+   delayBillingDays: number,
    eligibilityRequirements?: record,



+   offer?: {
+     billingProvider?: {
+       id?: number,
+       metadata?: {
+         avaTaxIntegration?: bool,
+       },
+       name?: string,
+       organizationCode?: string,
+       type?: 'stripe' | 'apple' | 'google' | 'amazon',
+     },
+     country?: {
+       code?: string,
+       currency?: {
+         code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+         scale?: number,
+       },
+       name?: string,
+     },
+     createdBy?: {
+       id?: number,
+     },
+     dateCreated?: number,
+     delayBilling?: {
+       days?: number,
+       text?: string,
+       type?: 'trial' | 'bundle',
+     },
+     frequencyDays?: number,
+     guid?: string,
+     image?: {
+       default: string,
+       large: string,
+       medium: string,
+       small: string,
+       url?: string,
+     },
+     introductory?: {
+       days?: number,
+       price?: number,
+       stripeCouponId?: string,
+       text?: string,
+     },
+     name?: string,
+     plan?: {
+       basePrice?: {
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         value?: number,
+       },
+       benefits?: List<{
+         text?: string,
+       }>,
+       billingProvider?: {
+         id?: number,
+         metadata?: {
+           avaTaxIntegration?: bool,
+         },
+         name?: string,
+         organizationCode?: string,
+         priceCode?: string,
+         productCode?: string,
+         type?: 'stripe' | 'apple' | 'google' | 'amazon',
+       },
+       country?: {
+         code?: string,
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         name?: string,
+       },
+       createdBy?: {
+         id?: number,
+       },
+       dateCreated?: number,
+       dateUpdated?: number,
+       defaultTrial?: {
+         units?: 'day',
+         value?: number,
+       },
+       delayBillingDays?: number,
+       description?: string,
+       emailTemplateId?: number,
+       family?: {
+         brands?: List<'echelon' | 'fitnation' | 'fitquest'>,
+         code?: 'spinco' | 'premier' | 'select' | 'flex' | 'fitpass' | 'lite' | 'choice' | 'free',
+         type?: 'connected' | 'disconnected',
+       },
+       frequency?: {
+         units?: 'month',
+         value?: number,
+       },
+       frequencyDays?: number,
+       id?: number,
+       name?: string,
+       sku?: string,
+       sortOrder?: number,
+       source?: {
+         accountId?: string,
+         productId?: string,
+         type?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
+       },
+       tags?: List<'humana' | 'gympass' | 'addon' | 'amazon' | 'popular' | 'directPurchase' | 'csOnly' | 'displayInAdmin'>,
+       updatedBy?: {
+         id?: number,
+       },
+     },
+     recurring?: {
+       price?: number,
+       stripePriceId?: string,
+     },
+     status?: 'draft' | 'published',
+   },
+   plans: List<{
      id?: number,
    }>,
    redeemedBy?: {
      id?: number,
    },
    referenceNumber?: string,
    retailer?: {
      bundleDays: number,
      id?: number,
      name: string,
    },
    serialNumber?: string,
    status?: 'inactive' | 'active' | 'redeemed' | 'deleted',



+   stripeCoupon: string,
    subscription?: {
      id?: number,
    },
  },
}

POST /redemption-codes/{code}/redemption

Redeem a single code

Request Body
{
  cardTokenId: string,
- planId?: number,



  serialNumber: string,
}

POST /redemption-codes/{code}/redemption

Redeem a single code

Request Body
{
  cardTokenId: string,



+ planId: number,
  serialNumber: string,
}

GET /redemption-codes/{code}/redemption

Check if a redemption code is available to be redeemed. Returns the status of a redemption code, not a redemption code itself.

Response Body
{
  data: {
    billingPeriodStarts: string,
    campaignCode?: string,
    code?: string,
-   delayBillingDays?: number,



    eligibilityRequirements?: record,
-   plans?: List<{






















































































































      id?: number,
    }>,
    referenceNumber?: string,
    retailer?: {
      bundleDays: number,
      id?: number,
      name: string,
    },
    serialNumber?: string,
    status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
-   stripeCoupon?: string,



  },
}

GET /redemption-codes/{code}/redemption

Check if a redemption code is available to be redeemed. Returns the status of a redemption code, not a redemption code itself.

Response Body
{
  data: {
    billingPeriodStarts: string,
    campaignCode?: string,
    code?: string,



+   delayBillingDays: number,
    eligibilityRequirements?: record,



+   offer?: {
+     billingProvider?: {
+       id?: number,
+       metadata?: {
+         avaTaxIntegration?: bool,
+       },
+       name?: string,
+       organizationCode?: string,
+       type?: 'stripe' | 'apple' | 'google' | 'amazon',
+     },
+     country?: {
+       code?: string,
+       currency?: {
+         code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+         scale?: number,
+       },
+       name?: string,
+     },
+     createdBy?: {
+       id?: number,
+     },
+     dateCreated?: number,
+     delayBilling?: {
+       days?: number,
+       text?: string,
+       type?: 'trial' | 'bundle',
+     },
+     frequencyDays?: number,
+     guid?: string,
+     image?: {
+       default: string,
+       large: string,
+       medium: string,
+       small: string,
+       url?: string,
+     },
+     introductory?: {
+       days?: number,
+       price?: number,
+       stripeCouponId?: string,
+       text?: string,
+     },
+     name?: string,
+     plan?: {
+       basePrice?: {
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         value?: number,
+       },
+       benefits?: List<{
+         text?: string,
+       }>,
+       billingProvider?: {
+         id?: number,
+         metadata?: {
+           avaTaxIntegration?: bool,
+         },
+         name?: string,
+         organizationCode?: string,
+         priceCode?: string,
+         productCode?: string,
+         type?: 'stripe' | 'apple' | 'google' | 'amazon',
+       },
+       country?: {
+         code?: string,
+         currency?: {
+           code?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL',
+           scale?: number,
+         },
+         name?: string,
+       },
+       createdBy?: {
+         id?: number,
+       },
+       dateCreated?: number,
+       dateUpdated?: number,
+       defaultTrial?: {
+         units?: 'day',
+         value?: number,
+       },
+       delayBillingDays?: number,
+       description?: string,
+       emailTemplateId?: number,
+       family?: {
+         brands?: List<'echelon' | 'fitnation' | 'fitquest'>,
+         code?: 'spinco' | 'premier' | 'select' | 'flex' | 'fitpass' | 'lite' | 'choice' | 'free',
+         type?: 'connected' | 'disconnected',
+       },
+       frequency?: {
+         units?: 'month',
+         value?: number,
+       },
+       frequencyDays?: number,
+       id?: number,
+       name?: string,
+       sku?: string,
+       sortOrder?: number,
+       source?: {
+         accountId?: string,
+         productId?: string,
+         type?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
+       },
+       tags?: List<'humana' | 'gympass' | 'addon' | 'amazon' | 'popular' | 'directPurchase' | 'csOnly' | 'displayInAdmin'>,
+       updatedBy?: {
+         id?: number,
+       },
+     },
+     recurring?: {
+       price?: number,
+       stripePriceId?: string,
+     },
+     status?: 'draft' | 'published',
+   },
+   plans: List<{
      id?: number,
    }>,
    referenceNumber?: string,
    retailer?: {
      bundleDays: number,
      id?: number,
      name: string,
    },
    serialNumber?: string,
    status?: 'inactive' | 'active' | 'redeemed' | 'deleted',



+   stripeCoupon: string,
  },
}

POST /redemption-codes/create

Create one or more redemption codes

Request Body
{
  campaignCode: string,
  codeLength?: number,
  count?: number,
- delayBillingDays?: number,



  eligibilityRequirements: record,
- plans?: List<{






    id?: number,
  }>,
  prefix: string,
  retailer?: {
    id?: number,
  },
  status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
  stripeCoupon: string,
}

POST /redemption-codes/create

Create one or more redemption codes

Request Body
{
  campaignCode: string,
  codeLength?: number,
  count?: number,



+ delayBillingDays: number,
  eligibilityRequirements: record,



+ offer: {
+   guid?: string,
+ },
+ plans: List<{
    id?: number,
  }>,
  prefix: string,
  retailer?: {
    id?: number,
  },
  status?: 'inactive' | 'active' | 'redeemed' | 'deleted',
  stripeCoupon: string,
}

GET /offers/count/partners

Plus(+) separated. Get count of the offers for given partner(s)

Guard: admin

GET /offers/count/partners

Plus(+) separated. Get count of the offers for given partner(s)

Guard: marketing

GET /partners/count/offers

Plus(+) separated. Get count of partners for given offers

Guard: admin

GET /partners/count/offers

Plus(+) separated. Get count of partners for given offers

Guard: marketing

WORK IN PROGRESS