import {z} from 'zod' export type Currency = 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STD' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW'; export type TaxCodes = Array; export type MinimumCommitmentInput = {amount_cents: number, invoice_display_name?: string | undefined, tax_codes?: TaxCodes | undefined} | null; export type ChargeModelEnum = 'dynamic' | 'graduated' | 'graduated_percentage' | 'package' | 'percentage' | 'standard' | 'volume'; export type ChargeObjectProperties = {grouped_by?: Array | undefined, pricing_group_keys?: Array | undefined, graduated_ranges?: (Array<{from_value: number, to_value: number | null, flat_amount: string, per_unit_amount: string}>) | undefined, graduated_percentage_ranges?: (Array<{from_value: number, to_value: number | null, rate: unknown, flat_amount: unknown}>) | undefined, amount?: string | undefined, free_units?: number | undefined, package_size?: number | undefined, rate?: string | undefined, fixed_amount?: string | undefined, free_units_per_events?: (number | null) | undefined, free_units_per_total_aggregation?: (string | null) | undefined, per_transaction_max_amount?: (unknown | null) | undefined, per_transaction_min_amount?: (unknown | null) | undefined, volume_ranges?: (Array<{from_value: number, to_value: number | null, flat_amount: string, per_unit_amount: string}>) | undefined, presentation_group_keys?: (Array<{value?: string | undefined, options?: ({display_in_invoice?: boolean | undefined}) | undefined}>) | undefined}; export type ChargeProperties = {grouped_by?: Array | undefined, pricing_group_keys?: Array | undefined, graduated_ranges?: (Array<{from_value: number, to_value: number | null, flat_amount: string, per_unit_amount: string}>) | undefined, graduated_percentage_ranges?: (Array<{from_value: number, to_value: number | null, rate: unknown, flat_amount: unknown}>) | undefined, amount?: string | undefined, free_units?: number | undefined, package_size?: number | undefined, rate?: string | undefined, fixed_amount?: string | undefined, free_units_per_events?: (number | null) | undefined, free_units_per_total_aggregation?: (string | null) | undefined, per_transaction_max_amount?: (unknown | null) | undefined, per_transaction_min_amount?: (unknown | null) | undefined, volume_ranges?: (Array<{from_value: number, to_value: number | null, flat_amount: string, per_unit_amount: string}>) | undefined}; export type ChargeFilterInput = {invoice_display_name?: (string | null) | undefined, properties: ChargeProperties, values: {[key: string]: Array}}; export type FixedChargeProperties = {amount?: string | undefined, graduated_ranges?: (Array<{from_value: number, to_value: number | null, flat_amount: string, per_unit_amount: string}>) | undefined, volume_ranges?: (Array<{from_value: number, to_value: number | null, flat_amount: string, per_unit_amount: string}>) | undefined}; export type UsageThresholdInput = {threshold_display_name?: (string | null) | undefined, amount_cents: number, recurring?: boolean | undefined}; export type PlanOverridesObject = {amount_cents?: number | undefined, amount_currency?: Currency | undefined, description?: string | undefined, invoice_display_name?: string | undefined, name?: string | undefined, tax_codes?: TaxCodes | undefined, trial_period?: number | undefined, minimum_commitment?: MinimumCommitmentInput | undefined, charges?: (Array<{id?: string | undefined, billable_metric_id?: string | undefined, code?: string | undefined, charge_model?: ChargeModelEnum | undefined, invoice_display_name?: string | undefined, min_amount_cents?: number | undefined, properties?: ChargeObjectProperties | undefined, filters?: Array | undefined, tax_codes?: TaxCodes | undefined, applied_pricing_unit?: ({code?: string | undefined, conversion_rate?: string | undefined}) | undefined}>) | undefined, fixed_charges?: (Array<{id: string, invoice_display_name?: string | undefined, units?: number | undefined, apply_units_immediately?: boolean | undefined, properties?: FixedChargeProperties | undefined, tax_codes?: TaxCodes | undefined}>) | undefined, usage_thresholds?: Array | undefined}; export type InvoiceCustomSectionInput = {skip_invoice_custom_sections?: boolean | undefined, invoice_custom_section_codes?: Array | undefined}; export type PaymentMethodReference = {payment_method_type?: ('provider' | 'manual') | undefined, payment_method_id?: string | undefined}; export type SubscriptionActivationRuleInput = {type: 'payment', timeout_hours?: number | undefined}; export type SubscriptionUpdateInput = {status?: ('active' | 'pending') | undefined, subscription: {name?: (string | null) | undefined, ending_at?: (string | null) | undefined, subscription_at?: string | undefined, plan_overrides?: PlanOverridesObject | undefined, invoice_custom_section?: InvoiceCustomSectionInput | undefined, payment_method?: PaymentMethodReference | undefined, consolidate_invoice?: boolean | undefined, billing_entity_code?: string | undefined, on_termination_credit_note?: ('credit' | 'refund' | 'offset' | 'skip') | undefined, on_termination_invoice?: ('generate' | 'skip') | undefined, purchase_order_number?: (string | null) | undefined, progressive_billing_disabled?: boolean | undefined, usage_thresholds?: Array | undefined, activation_rules?: Array | undefined}}; export type UpdateApiSubscriptionsExternalIdArgs = {status?: ('active' | 'pending') | undefined, body: SubscriptionUpdateInput}; export type UpdateApiSubscriptionsExternalIdOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const currency = z.enum(["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW"]); export const invoiceCustomSectionObject = z.object({lago_id: z.string(), name: z.string(), code: z.string(), description: z.string().optional(), details: z.string().optional(), display_name: z.string().optional(), applied_to_organization: z.boolean().optional(), organization_id: z.string().optional(), created_at: z.string().optional()}); export const appliedInvoiceCustomSectionObject = z.object({lago_id: z.string(), created_at: z.string(), invoice_custom_section_id: z.string().optional(), invoice_custom_section: invoiceCustomSectionObject}); export const paymentMethodReference = z.object({payment_method_type: z.enum(["provider", "manual"]).optional(), payment_method_id: z.string().optional()}); export const subscriptionActivationRuleObject = z.object({lago_id: z.string(), type: z.literal("payment"), timeout_hours: z.number().int(), status: z.enum(["inactive", "pending", "satisfied", "declined", "failed", "expired", "not_applicable"]), expires_at: z.string().nullable(), created_at: z.string(), updated_at: z.string()}); export const taxObject = z.object({lago_id: z.string(), name: z.string(), code: z.string(), description: z.string().nullable(), rate: z.number(), applied_to_organization: z.boolean(), applied_to_billing_entities_codes: z.array(z.string()).optional(), created_at: z.string()}); export const minimumCommitmentObject = z.object({lago_id: z.string(), plan_code: z.string().optional(), amount_cents: z.number().int(), invoice_display_name: z.string().nullable().optional(), interval: z.enum(["weekly", "monthly", "quarterly", "semiannual", "yearly"]).optional(), created_at: z.string(), updated_at: z.string().optional(), taxes: z.array(taxObject).optional()}).nullable(); export const chargeModelEnum = z.enum(["dynamic", "graduated", "graduated_percentage", "package", "percentage", "standard", "volume"]); export const chargeObjectProperties = z.object({grouped_by: z.array(z.string()).optional(), pricing_group_keys: z.array(z.string()).optional(), graduated_ranges: z.array(z.object({from_value: z.number().int(), to_value: z.number().int().nullable(), flat_amount: z.string(), per_unit_amount: z.string()})).optional(), graduated_percentage_ranges: z.array(z.object({from_value: z.number().int(), to_value: z.number().int().nullable(), rate: z.string(), flat_amount: z.string()})).optional(), amount: z.string().optional(), free_units: z.number().int().optional(), package_size: z.number().int().optional(), rate: z.string().optional(), fixed_amount: z.string().optional(), free_units_per_events: z.number().int().nullable().optional(), free_units_per_total_aggregation: z.string().nullable().optional(), per_transaction_max_amount: z.string().nullable().optional(), per_transaction_min_amount: z.string().nullable().optional(), volume_ranges: z.array(z.object({from_value: z.number().int(), to_value: z.number().int().nullable(), flat_amount: z.string(), per_unit_amount: z.string()})).optional(), presentation_group_keys: z.array(z.object({value: z.string().optional(), options: z.object({display_in_invoice: z.boolean().optional()}).optional()})).optional()}); export const chargeProperties = z.object({grouped_by: z.array(z.string()).optional(), pricing_group_keys: z.array(z.string()).optional(), graduated_ranges: z.array(z.object({from_value: z.number().int(), to_value: z.number().int().nullable(), flat_amount: z.string(), per_unit_amount: z.string()})).optional(), graduated_percentage_ranges: z.array(z.object({from_value: z.number().int(), to_value: z.number().int().nullable(), rate: z.string(), flat_amount: z.string()})).optional(), amount: z.string().optional(), free_units: z.number().int().optional(), package_size: z.number().int().optional(), rate: z.string().optional(), fixed_amount: z.string().optional(), free_units_per_events: z.number().int().nullable().optional(), free_units_per_total_aggregation: z.string().nullable().optional(), per_transaction_max_amount: z.string().nullable().optional(), per_transaction_min_amount: z.string().nullable().optional(), volume_ranges: z.array(z.object({from_value: z.number().int(), to_value: z.number().int().nullable(), flat_amount: z.string(), per_unit_amount: z.string()})).optional()}); export const chargeFilterObject = z.object({lago_id: z.string().optional(), charge_code: z.string().optional(), invoice_display_name: z.string().nullable(), properties: chargeProperties, values: z.record(z.string(), z.array(z.string()))}); export const chargeObject = z.object({lago_id: z.string(), lago_billable_metric_id: z.string(), code: z.string().optional(), billable_metric_code: z.string(), invoice_display_name: z.string().nullable().optional(), created_at: z.string(), charge_model: chargeModelEnum, pay_in_advance: z.boolean(), invoiceable: z.boolean(), regroup_paid_fees: z.enum(["null", "invoice"]).nullable(), prorated: z.boolean(), min_amount_cents: z.number().int(), properties: chargeObjectProperties, filters: z.array(chargeFilterObject), taxes: z.array(taxObject).optional(), applied_pricing_unit: z.object({code: z.string(), conversion_rate: z.string()}).nullable().optional(), accepts_target_wallet: z.boolean().optional(), lago_parent_id: z.string().nullable().optional()}); export const fixedChargeProperties = z.object({amount: z.string().optional(), graduated_ranges: z.array(z.object({from_value: z.number().int(), to_value: z.number().int().nullable(), flat_amount: z.string(), per_unit_amount: z.string()})).optional(), volume_ranges: z.array(z.object({from_value: z.number().int(), to_value: z.number().int().nullable(), flat_amount: z.string(), per_unit_amount: z.string()})).optional()}); export const fixedChargeObject = z.object({lago_id: z.string(), lago_add_on_id: z.string(), invoice_display_name: z.string().nullable(), add_on_code: z.string(), created_at: z.string(), code: z.string(), charge_model: z.enum(["standard", "graduated", "volume"]), pay_in_advance: z.boolean(), prorated: z.boolean(), properties: fixedChargeProperties, units: z.string(), lago_parent_id: z.string().nullable().optional(), taxes: z.array(taxObject).optional()}); export const usageThresholdObject = z.object({lago_id: z.string(), threshold_display_name: z.string().nullable(), amount_cents: z.number().int(), recurring: z.boolean(), created_at: z.string(), updated_at: z.string()}); export const applicableUsageThreshold = z.object({threshold_display_name: z.string().nullable(), amount_cents: z.number().int(), recurring: z.boolean()}); export const planEntitlementPrivilegeObject = z.object({code: z.string(), name: z.string().nullable(), value_type: z.enum(["integer", "boolean", "string", "select"]), config: z.object({select_options: z.array(z.string()).optional()}), value: z.union([z.number().int(), z.boolean(), z.string()])}); export const planEntitlementObject = z.object({code: z.string(), name: z.string().nullable(), description: z.string().nullable(), privileges: z.array(planEntitlementPrivilegeObject)}); export const planEntitlement = z.object({entitlement: planEntitlementObject}); export const metadataObject = z.record(z.string(), z.string().nullable()).nullable(); export const planObject = z.object({lago_id: z.string(), name: z.string(), invoice_display_name: z.string().nullable().optional(), created_at: z.string(), code: z.string(), interval: z.enum(["weekly", "monthly", "quarterly", "semiannual", "yearly"]), description: z.string().nullable().optional(), amount_cents: z.number().int(), amount_currency: currency, trial_period: z.number().nullable().optional(), pay_in_advance: z.boolean().optional(), bill_charges_monthly: z.boolean().nullable().optional(), bill_fixed_charges_monthly: z.boolean().nullable().optional(), parent_id: z.string().nullable().optional(), pending_deletion: z.boolean().optional(), minimum_commitment: minimumCommitmentObject.optional(), charges: z.array(chargeObject).optional(), fixed_charges: z.array(fixedChargeObject).optional(), taxes: z.array(taxObject).optional(), usage_thresholds: z.array(usageThresholdObject).optional(), applicable_usage_thresholds: z.array(applicableUsageThreshold).optional(), entitlements: z.array(planEntitlement).optional(), metadata: metadataObject.optional()}); export const subscriptionEntitlementPrivilegeObject = z.object({code: z.string(), name: z.string().nullable(), value_type: z.enum(["integer", "boolean", "string", "select"]), config: z.object({select_options: z.array(z.string()).optional()}), value: z.union([z.number().int(), z.boolean(), z.string()]), plan_value: z.union([z.number().int(), z.boolean(), z.string()]).nullable(), override_value: z.union([z.number().int(), z.boolean(), z.string()]).nullable()}); export const subscriptionEntitlementObject = z.object({code: z.string(), name: z.string().nullable(), description: z.string().nullable(), privileges: z.array(subscriptionEntitlementPrivilegeObject), overrides: z.record(z.string(), z.unknown())}); export const subscriptionObjectExtended = z.object({lago_id: z.string(), external_id: z.string(), lago_customer_id: z.string(), external_customer_id: z.string(), billing_entity_code: z.string().optional(), billing_time: z.enum(["calendar", "anniversary"]), name: z.string().nullable(), plan_code: z.string(), plan_amount_cents: z.number().int(), plan_amount_currency: currency, status: z.enum(["active", "canceled", "incomplete", "pending", "terminated"]), created_at: z.string(), canceled_at: z.string().nullable(), started_at: z.string().nullable(), ending_at: z.string().nullable(), subscription_at: z.string(), terminated_at: z.string().nullable(), previous_plan_code: z.string().nullable(), next_plan_code: z.string().nullable(), downgrade_plan_date: z.string().nullable(), trial_ended_at: z.string().nullable(), current_billing_period_started_at: z.string().nullable(), current_billing_period_ending_at: z.string().nullable(), on_termination_credit_note: z.enum(["credit", "refund", "offset", "skip"]).nullable(), on_termination_invoice: z.enum(["generate", "skip"]), applied_invoice_custom_sections: z.array(appliedInvoiceCustomSectionObject).optional(), payment_method: paymentMethodReference, consolidate_invoice: z.boolean(), progressive_billing_disabled: z.boolean(), cancellation_reason: z.enum(["payment_failed", "timeout", "manual"]).nullable(), activated_at: z.string().nullable(), activation_rules: z.array(subscriptionActivationRuleObject), purchase_order_number: z.string().nullable(), plan: planObject.optional(), applicable_usage_thresholds: z.array(applicableUsageThreshold).optional(), entitlements: z.array(subscriptionEntitlementObject).optional()}); export const subscriptionExtended = z.object({subscription: subscriptionObjectExtended, authorization: z.object({id: z.string(), object: z.string(), amount: z.number().int(), amount_capturable: z.number().int(), status: z.string()}).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Update a subscription * * PUT /subscriptions/{external_id} */ export const updateApiSubscriptionsExternalId = async (args: UpdateApiSubscriptionsExternalIdArgs, options?: UpdateApiSubscriptionsExternalIdOptions) => { const {baseUrl = "https://api.getlago.com/api/v1", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args.status != null) query.append("status", String(args.status)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/subscriptions/${encodeURIComponent(String(args.external_id))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "PUT", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(subscriptionExtended, await res.json()) };