chargebee/types/resources/Purchase.d.ts

A library for integrating with Chargebee.

///<reference path='./../core.d.ts'/>
///<reference path='./../index.d.ts'/>

declare module 'chargebee' {
  export interface Purchase {
    id?: string;
    customer_id: string;
    created_at?: number;
    modified_at?: number;
    subscription_ids?: string[];
    invoice_ids?: string[];
  }

  export namespace Purchase {
    export class PurchaseResource {
      create(
        input: CreateInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<CreateResponse>>;

      estimate(
        input: EstimateInputParam,
        headers?: ChargebeeRequestHeader,
      ): Promise<ChargebeeResponse<EstimateResponse>>;
    }

    export interface CreateResponse {
      purchase: Purchase;
    }

    export interface EstimateResponse {
      estimate: Estimate;
    }

    // REQUEST PARAMS
    //---------------

    export interface CreateInputParam {
      customer_id: string;
      payment_source_id?: string;
      replace_primary_payment_source?: boolean;
      invoice_info?: InvoiceInfoCreateInputParam;
      payment_schedule?: PaymentScheduleCreateInputParam;
      statement_descriptor?: StatementDescriptorCreateInputParam;
      payment_intent?: PaymentIntentCreateInputParam;
      purchase_items?: PurchaseItemsCreateInputParam[];
      item_tiers?: ItemTiersCreateInputParam[];
      shipping_addresses?: ShippingAddressesCreateInputParam[];
      discounts?: DiscountsCreateInputParam[];
      subscription_info?: SubscriptionInfoCreateInputParam[];
      contract_terms?: ContractTermsCreateInputParam[];
    }
    export interface EstimateInputParam {
      client_profile_id?: string;
      customer_id?: string;
      customer?: CustomerEstimateInputParam;
      billing_address?: BillingAddressEstimateInputParam;
      purchase_items?: PurchaseItemsEstimateInputParam[];
      item_tiers?: ItemTiersEstimateInputParam[];
      shipping_addresses?: ShippingAddressesEstimateInputParam[];
      discounts?: DiscountsEstimateInputParam[];
      subscription_info?: SubscriptionInfoEstimateInputParam[];
      contract_terms?: ContractTermsEstimateInputParam[];
    }
    export interface StatementDescriptorCreateInputParam {
      descriptor?: string;
    }
    export interface PaymentScheduleCreateInputParam {
      scheme_id?: string;
      amount?: number;
    }
    export interface InvoiceInfoCreateInputParam {
      po_number?: string;
      notes?: string;
    }
    export interface PaymentIntentCreateInputParam {
      id?: string;
      gateway_account_id?: string;
      gw_token?: string;
      payment_method_type?:
        | 'card'
        | 'ideal'
        | 'sofort'
        | 'bancontact'
        | 'google_pay'
        | 'dotpay'
        | 'giropay'
        | 'apple_pay'
        | 'upi'
        | 'netbanking_emandates'
        | 'paypal_express_checkout'
        | 'direct_debit'
        | 'boleto'
        | 'venmo'
        | 'amazon_payments'
        | 'pay_to'
        | 'faster_payments'
        | 'sepa_instant_transfer'
        | 'klarna_pay_now'
        | 'online_banking_poland'
        | 'payconiq_by_bancontact';
      reference_id?: string;
      /**
       * @deprecated Please refer API docs to use other attributes
       */
      gw_payment_method_id?: string;
      additional_information?: any;
    }

    export interface SubscriptionInfoCreateInputParam {
      index: number;
      subscription_id?: string;
      billing_cycles?: number;
      contract_term_billing_cycle_on_renewal?: number;
      meta_data?: any;
    }
    export interface PurchaseItemsCreateInputParam {
      index: number;
      item_price_id: string;
      quantity?: number;
      unit_amount?: number;
      unit_amount_in_decimal?: string;
      quantity_in_decimal?: string;
    }
    export interface DiscountsCreateInputParam {
      index?: number;
      coupon_id?: string;
      percentage?: number;
      amount?: number;
      included_in_mrr?: boolean;
    }
    export interface ContractTermsCreateInputParam {
      index: number;
      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
      cancellation_cutoff_period?: number;
    }
    export interface ItemTiersCreateInputParam {
      index: number;
      item_price_id?: string;
      starting_unit?: number;
      ending_unit?: number;
      price?: number;
      starting_unit_in_decimal?: string;
      ending_unit_in_decimal?: string;
      price_in_decimal?: string;
    }
    export interface ShippingAddressesCreateInputParam {
      first_name?: string;
      last_name?: string;
      email?: string;
      company?: string;
      phone?: string;
      line1?: string;
      line2?: string;
      line3?: string;
      city?: string;
      state?: string;
      state_code?: string;
      country?: string;
      zip?: string;
      validation_status?: ValidationStatusEnum;
    }
    export interface BillingAddressEstimateInputParam {
      line1?: string;
      line2?: string;
      line3?: string;
      city?: string;
      state_code?: string;
      zip?: string;
      country?: string;
      validation_status?: ValidationStatusEnum;
    }
    export interface CustomerEstimateInputParam {
      vat_number?: string;
      vat_number_prefix?: string;
      registered_for_gst?: boolean;
      taxability?: TaxabilityEnum;
      entity_code?: EntityCodeEnum;
      exempt_number?: string;
      exemption_details?: any;
      customer_type?: CustomerTypeEnum;
    }

    export interface SubscriptionInfoEstimateInputParam {
      index: number;
      subscription_id?: string;
      billing_cycles?: number;
      contract_term_billing_cycle_on_renewal?: number;
    }
    export interface PurchaseItemsEstimateInputParam {
      index: number;
      item_price_id: string;
      quantity?: number;
      unit_amount?: number;
      unit_amount_in_decimal?: string;
      quantity_in_decimal?: string;
    }
    export interface DiscountsEstimateInputParam {
      index?: number;
      coupon_id?: string;
      percentage?: number;
      amount?: number;
      included_in_mrr?: boolean;
    }
    export interface ContractTermsEstimateInputParam {
      index: number;
      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
      cancellation_cutoff_period?: number;
    }
    export interface ItemTiersEstimateInputParam {
      index: number;
      item_price_id?: string;
      starting_unit?: number;
      ending_unit?: number;
      price?: number;
      starting_unit_in_decimal?: string;
      ending_unit_in_decimal?: string;
      price_in_decimal?: string;
    }
    export interface ShippingAddressesEstimateInputParam {
      first_name?: string;
      last_name?: string;
      email?: string;
      company?: string;
      phone?: string;
      line1?: string;
      line2?: string;
      line3?: string;
      city?: string;
      state?: string;
      state_code?: string;
      country?: string;
      zip?: string;
      validation_status?: ValidationStatusEnum;
    }
  }
}