@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.
70 lines • 3.61 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema.js';
export interface Customer {
/** The first name of the customer */
firstName?: string;
/** The last name of the customer */
lastName?: string;
/** The email address of the customer */
email?: string;
/** A comma-separated list of emails that should be cc’d on all customer communications (i.e. “joe@example.com, sue@example.com”) */
ccEmails?: string | null;
/** The organization of the customer. If no value, `null` or empty string is provided, `organization` will be populated with the customer's first and last name, separated with a space. */
organization?: string | null;
/** The unique identifier used within your own application for this customer */
reference?: string | null;
/** The customer ID in Chargify */
id?: number;
/** The timestamp in which the customer object was created in Chargify */
createdAt?: string;
/** The timestamp in which the customer object was last edited */
updatedAt?: string;
/** The customer’s shipping street address (i.e. “123 Main St.”) */
address?: string | null;
/** Second line of the customer’s shipping address i.e. “Apt. 100” */
address2?: string | null;
/** The customer’s shipping address city (i.e. “Boston”) */
city?: string | null;
/** The customer’s shipping address state (i.e. “MA”) */
state?: string | null;
/** The customer's full name of state */
stateName?: string | null;
/** The customer’s shipping address zip code (i.e. “12345”) */
zip?: string | null;
/** The customer shipping address country */
country?: string | null;
/** The customer's full name of country */
countryName?: string | null;
/** The phone number of the customer */
phone?: string | null;
/** Is the customer verified to use ACH as a payment method. */
verified?: boolean | null;
/** The timestamp of when the Billing Portal entry was created at for the customer */
portalCustomerCreatedAt?: string | null;
/** The timestamp of when the Billing Portal invite was last sent at */
portalInviteLastSentAt?: string | null;
/** The timestamp of when the Billing Portal invite was last accepted */
portalInviteLastAcceptedAt?: string | null;
/** The tax exempt status for the customer. Acceptable values are true or 1 for true and false or 0 for false. */
taxExempt?: boolean;
/** The VAT business identification number for the customer. This number is used to determine VAT tax opt out rules. It is not validated when added or updated on a customer record. Instead, it is validated via VIES before calculating taxes. Only valid business identification numbers will allow for VAT opt out. */
vatNumber?: string | null;
/** The parent ID in Chargify if applicable. Parent is another Customer object. */
parentId?: number | null;
/** The locale for the customer to identify language-region */
locale?: string | null;
defaultSubscriptionGroupUid?: string | null;
/** The Salesforce ID for the customer */
salesforceId?: string | null;
/** The Tax Exemption Reason Code for the customer */
taxExemptReason?: string | null;
/** The default auto-renewal profile ID for the customer */
defaultAutoRenewalProfileId?: number | null;
[key: string]: unknown;
}
export declare const customerSchema: Schema<Customer>;
//# sourceMappingURL=customer.d.ts.map