@maxio-com/advanced-billing-sdk
Version:
Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.
29 lines • 1.35 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core.js';
import { ReferralValidationResponse } from '../models/referralValidationResponse.js';
import { BaseController } from './baseController.js';
export declare class ReferralCodesController extends BaseController {
/**
* Use this method to determine if the referral code is valid and applicable within your Site. This
* method is useful for validating referral codes that are entered by a customer.
*
* ## Referrals Documentation
*
* Full documentation on how to use the referrals feature in the Advanced Billing UI can be located
* [here](https://maxio.zendesk.com/hc/en-us/sections/24286965611405-Referrals).
*
* ## Server 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 returned.
*
* @param code The referral code you are trying to validate
* @return Response from the API call
*/
validateReferralCode(code: string, requestOptions?: RequestOptions): Promise<ApiResponse<ReferralValidationResponse>>;
}
//# sourceMappingURL=referralCodesController.d.ts.map