Référence de la base de données

interface AccessSchedule {
  credit_type_id: string;
  credit_type_name: string;
  schedule_items: Array<{
    id: string;
    /** ISO-8601 formatted timestamp */
    date: string;
    /** ISO-8601 formatted timestamp */
    end_date: string | null;
    /** Float */
    amount: number;
  }>;
}

interface InvoiceSchedule {
  credit_type_id: string;
  credit_type_name: string;
  do_not_invoice: boolean;
  schedule_items: Array<{
    id: string;
    /** ISO-8601 formatted timestamp */
    date: string;
    /** Float */
    amount: number;
    invoice_id: string | null;
  }>;
  recurring_schedule: {
    /** ISO-8601 formatted timestamp */
    start_date: string;
    /** ISO-8601 formatted timestamp */
    end_date: string;
    /** Float */
    amount: number;
    amount_distribution: "divided" | "divided_rounded" | "each";
    frequency: "annual" | "monthly" | "quarterly" | "semi_annual";
    /** Float */
    quantity?: number;
    /** Float */
    unit_price?: number;
  } | null;
}

type LedgerEntry =
  | {
      /**
       * Represents the starting balance of a postpaid commit.
       */
      type: "postpaid_initial_balance";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
    }
  | {
      /**
       * Represents deductions from the remaining obligation of the
       * postpaid commit as the result of an invoice with usage that
       * applies to this commit.
       */
      type: "postpaid_automated_invoice_deduction";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      invoice_id: string;
    }
  | {
      /**
       * Represents a true-up invoice that was issued for this commit to
       * cover usage that was not covered by automated usage invoices.
       */
      type: "postpaid_trueup";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      invoice_id: string;
    }
  | {
      /**
       * Represents that a prepaid commit segment was started and the customer
       * now has access to the usage amount for that segment. These segments
       * are described in the access schedule of the prepaid commit.
       */
      type: "prepaid_segment_start";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
    }
  | {
      /**
       * Represents deductions from the prepaid commit segment caused by a
       * usage invoice that included usage applicable to this commit.
       */
      type: "prepaid_automated_invoice_deduction";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      /**
       * Represents unused usage from the prepaid commit which was rolled
       * over to a new contract.
       */
      type: "prepaid_rollover";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      new_contract_id: string;
      new_commit_id: string;
    }
  | {
      type: "prepaid_commit_canceled";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      type: "prepaid_commit_credited";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      /**
       * Represents commit amount that was unused and expired at the end of
       * a commit segment. Does not include usage that rolled over to a new
       * contract.
       */
      type: "prepaid_segment_expiration";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
    }
  | {
      type: "prepaid_manual";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      reason: string;
    }
  | {
      type: "postpaid_manual";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
    };

type CommitSpecifier = {
  product_id?: string;
  product_tags?: string[];
  presentation_group_values?: {
    [key: string]: string;
  };
  pricing_group_values?: {
    [key: string]: string;
  };
}

interface AccessSchedule {
  credit_type_id: string;
  credit_type_name: string;
  schedule_items: Array<{
    id: string;
    /** ISO-8601 formatted timestamp */
    date: string;
    /** ISO-8601 formatted timestamp */
    end_date: string | null;
    /** Float */
    amount: number;
  }>;
}

interface InvoiceSchedule {
  credit_type_id: string;
  credit_type_name: string;
  do_not_invoice: boolean;
  schedule_items: Array<{
    id: string;
    /** ISO-8601 formatted timestamp */
    date: string;
    /** Float */
    amount: number;
    invoice_id: string | null;
  }>;
  recurring_schedule: {
    /** ISO-8601 formatted timestamp */
    start_date: string;
    /** ISO-8601 formatted timestamp */
    end_date: string;
    /** Float */
    amount: number;
    amount_distribution: "divided" | "divided_rounded" | "each";
    frequency: "annual" | "monthly" | "quarterly" | "semi_annual";
    /** Float */
    quantity?: number;
    /** Float */
    unit_price?: number;
  } | null;
}

type LedgerEntry =
  | {
      /**
       * Represents the starting balance of a postpaid commit.
       */
      type: "postpaid_initial_balance";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
    }
  | {
      /**
       * Represents deductions from the remaining obligation of the
       * postpaid commit as the result of an invoice with usage that
       * applies to this commit.
       */
      type: "postpaid_automated_invoice_deduction";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      invoice_id: string;
    }
  | {
      /**
       * Represents a true-up invoice that was issued for this commit to
       * cover usage that was not covered by automated usage invoices.
       */
      type: "postpaid_trueup";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      invoice_id: string;
    }
  | {
      /**
       * Represents that a prepaid commit segment was started and the customer
       * now has access to the usage amount for that segment. These segments
       * are described in the access schedule of the prepaid commit.
       */
      type: "prepaid_segment_start";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
    }
  | {
      /**
       * Represents deductions from the prepaid commit segment caused by a
       * usage invoice that included usage applicable to this commit.
       */
      type: "prepaid_automated_invoice_deduction";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      /**
       * Represents unused usage from the prepaid commit which was rolled
       * over to a new contract.
       */
      type: "prepaid_rollover";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      new_contract_id: string;
      new_commit_id: string;
    }
  | {
      type: "prepaid_commit_canceled";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      type: "prepaid_commit_credited";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      /**
       * Represents commit amount that was unused and expired at the end of
       * a commit segment. Does not include usage that rolled over to a new
       * contract.
       */
      type: "prepaid_segment_expiration";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
    }
  | {
      type: "prepaid_manual";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      reason: string;
    }
  | {
      type: "postpaid_manual";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
    }
  | {
      /**
       * Represents that a credit segment was started and the customer
       * now has access to the usage amount for that segment. These segments
       * are described in the access schedule of the credit.
       */
      type: "credit_segment_start";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
    }
  | {
      /**
       * Represents deductions from the credit segment caused by a
       * usage invoice that included usage applicable to this credit.
       */
      type: "credit_automated_invoice_deduction";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      type: "credit_commit_canceled";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      type: "credit_commit_credited";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      invoice_id: string;
    }
  | {
      /**
       * Represents credit amount that was unused and expired at the end of
       * a credit segment.
       */
      type: "credit_segment_expiration";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
    }
  | {
      type: "credit_manual";
      /** ISO-8601 formatted timestamp */
      timestamp: string;
      /** Float */
      amount: number;
      segment_id: string;
      reason: string;
    };

type CommitSpecifier = {
  product_id?: string;
  product_tags?: string[];
  presentation_group_values?: {
    [key: string]: string;
  };
  pricing_group_values?: {
    [key: string]: string;
  };
}

interface AccessAmount {
  unit_price: number;
  quantity: number;
  credit_type_id: string;
  credit_type_name: string;
}

interface InvoiceAmount {
  unit_price: number;
  quantity: number;
  credit_type_id: string;
  credit_type_name: string;
}

type CommitSpecifier = {
  product_id?: string;
  product_tags?: string[];
  presentation_group_values?: {
    [key: string]: string;
  };
  pricing_group_values?: {
    [key: string]: string;
  };
}

enum CommitDurationUnit {
  PERIODS = "PERIODS",
}

interface CommitDuration {
  unit: CommitDurationUnit;
  value: number;
}

interface ProrationRounding {
  access: {
    rounding_method: "round_up" | "round_down" | "round_half_up";
    decimal_places: number;
  };
  invoice: {
    rounding_method: "round_up" | "round_down" | "round_half_up";
    decimal_places: number;
  };
}

enum SubscriptionAllocationForRecurringCommitEnum {
  POOLED = "pooled",
  INDIVIDUAL = "individual",
}

type SubscriptionConfig = {
  subscription_id: string;
  apply_seat_increase_config: {
    is_prorated: boolean;
  };
  allocation: SubscriptionAllocationForRecurringCommitEnum;
};

enum SubscriptionInvoicePlacementEnum {
  ON_USAGE_INVOICE = "ON_USAGE_INVOICE",
  ON_SCHEDULED_INVOICE = "ON_SCHEDULED_INVOICE",
}

interface BillingCycleConfig {
  anchor_date: timestamp;
  invoice_placement: SubscriptionInvoicePlacementEnum;
}

interface ProrationRounding {
  rounding_method: "round_up" | "round_down" | "round_half_up";
  decimal_places: number;
}

interface Schedule {
  schedule_items: Array<{
    id: string;
    /** ISO-8601 formatted timestamp */
    date: string;
    /** Float */
    amount: number;
  }>;
  recurring_schedule: {
    /** ISO-8601 formatted timestamp */
    start_date: string;
    /** ISO-8601 formatted timestamp */
    end_date: string;
    /** Float */
    amount: number;
    amount_distribution: "divided" | "divided_rounded" | "each";
    frequency: "annual" | "monthly" | "quarterly" | "semi_annual";
    /** Float */
    quantity?: number;
    /** Float */
    unit_price?: number;
  } | null;
}

type OverrideSpecifier = {
  commit_ids?: string[];
  product_id?: string;
  product_tags?: string[];
  pricing_group_values?: Array<{
    name: string;
    value: string;
  }>;
  presentation_group_values?: Array<{
    name: string;
    value: string;
  }>;
  // If set, the override will only apply to usage that burns down commits / credits that were created by the specified recurring config
  recurring_commit_ids?: string[];
  any_commit_or_credit_ids?: string[];
};

type Rate =
  | {
      type: "flat";
      unit_price: number;
    }
  | {
      type: "percentage";
      fraction: number;
      use_list_prices: boolean;
    }
  | {
      type: "subscription";
      unit_price: number;
      quantity: number;
    };

type PaymentGateway = {
  type: "stripe";
  stripe: {
    payment_intent_id: string;
    payment_method_id: string;
    error: string | null;
  };
} | null;