expresspayments
Version:
ExpressPayments API wrapper
299 lines (245 loc) • 11.4 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'expresspayments' {
namespace ExpressPayments {
/**
* This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.
*
* Related guide: [Save a card during payment](https://docs.epayments.network/payments/save-during-payment)
*/
interface Customer {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'customer';
/**
* The customer's address.
*/
address?: ExpressPayments.Address | null;
/**
* Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.
*/
balance: number;
/**
* The current funds being held by ExpressPayments on behalf of the customer. These funds can be applied towards payment intents with source "cash_balance". The settings[reconciliation_mode] field describes whether these funds are applied to such payment intents manually or automatically.
*/
cash_balance?: ExpressPayments.CashBalance | null;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: number;
/**
* Three-letter [ISO code for the currency](https://docs.epayments.network/currencies) the customer can be charged in for recurring billing purposes.
*/
currency?: string | null;
/**
* ID of the default payment source for the customer.
*
* If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.epayments.network/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
*/
default_source: string | ExpressPayments.CustomerSource | null;
deleted?: void;
/**
* When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date.
*
* If an invoice is marked uncollectible by [dunning](https://docs.epayments.network/billing/automatic-collection), `delinquent` doesn't get reset to `false`.
*/
delinquent?: boolean | null;
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
description: string | null;
/**
* Describes the current discount active on the customer, if there is one.
*/
discount?: ExpressPayments.Discount | null;
/**
* The customer's email address.
*/
email: string | null;
/**
* The current multi-currency balances, if any, being stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that will be added to their next invoice denominated in that currency. These balances do not refer to any unpaid invoices. They solely track amounts that have yet to be successfully applied to any invoice. A balance in a particular currency is only applied to any invoice as an invoice in that currency is finalized.
*/
invoice_credit_balance?: {
[]: number;
};
/**
* The prefix for the customer used to generate unique invoice numbers.
*/
invoice_prefix?: string | null;
invoice_settings: Customer.InvoiceSettings;
/**
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
*/
livemode: boolean;
/**
* Set of [key-value pairs](https://docs.epayments.network/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*/
metadata: ExpressPayments.Metadata;
/**
* The customer's full name or business name.
*/
name?: string | null;
/**
* The suffix of the customer's next invoice number, e.g., 0001.
*/
next_invoice_sequence?: number;
/**
* The customer's phone number.
*/
phone?: string | null;
/**
* The customer's preferred locales (languages), ordered by preference.
*/
preferred_locales?: Array<string> | null;
/**
* Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
*/
shipping: Customer.Shipping | null;
/**
* The customer's payment sources, if any.
*/
sources?: ApiList<ExpressPayments.CustomerSource>;
/**
* The customer's current subscriptions, if any.
*/
subscriptions?: ApiList<ExpressPayments.Subscription>;
tax?: Customer.Tax;
/**
* Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**.
*/
tax_exempt?: Customer.TaxExempt | null;
/**
* The customer's tax IDs.
*/
tax_ids?: ApiList<ExpressPayments.TaxId>;
/**
* ID of the test clock this customer belongs to.
*/
test_clock?: string | ExpressPayments.TestHelpers.TestClock | null;
}
namespace Customer {
interface InvoiceSettings {
/**
* Default custom fields to be displayed on invoices for this customer.
*/
custom_fields: Array<InvoiceSettings.CustomField> | null;
/**
* ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
*/
default_payment_method:
| string
| ExpressPayments.PaymentMethod
| null;
/**
* Default footer to be displayed on invoices for this customer.
*/
footer: string | null;
/**
* Default options for invoice PDF rendering for this customer.
*/
rendering_options: InvoiceSettings.RenderingOptions | null;
}
namespace InvoiceSettings {
interface CustomField {
/**
* The name of the custom field.
*/
name: string;
/**
* The value of the custom field.
*/
value: string;
}
interface RenderingOptions {
/**
* How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
*/
amount_tax_display: string | null;
}
}
interface Shipping {
address?: ExpressPayments.Address;
/**
* The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
*/
carrier?: string | null;
/**
* Recipient name.
*/
name?: string;
/**
* Recipient phone (including extension).
*/
phone?: string | null;
/**
* The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
*/
tracking_number?: string | null;
}
interface Tax {
/**
* Surfaces if automatic tax computation is possible given the current customer location information.
*/
automatic_tax: Tax.AutomaticTax;
/**
* A recent IP address of the customer used for tax reporting and tax location inference.
*/
ip_address: string | null;
/**
* The customer's location as identified by ExpressPayments Tax.
*/
location: Tax.Location | null;
}
namespace Tax {
type AutomaticTax =
| 'failed'
| 'not_collecting'
| 'supported'
| 'unrecognized_location';
interface Location {
/**
* The customer's country as identified by ExpressPayments Tax.
*/
country: string;
/**
* The data source used to infer the customer's location.
*/
source: Location.Source;
/**
* The customer's state, county, province, or region as identified by ExpressPayments Tax.
*/
state: string | null;
}
namespace Location {
type Source =
| 'billing_address'
| 'ip_address'
| 'payment_method'
| 'shipping_destination';
}
}
type TaxExempt = 'exempt' | 'none' | 'reverse';
}
/**
* The DeletedCustomer object.
*/
interface DeletedCustomer {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'customer';
/**
* Always true for a deleted object
*/
deleted: true;
}
}
}