80 lines
2.8 KiB
TypeScript
80 lines
2.8 KiB
TypeScript
import { Hold } from './Holds.js';
|
|
import { Plan } from './Plans.js';
|
|
import { Dispute } from './../Disputes.js';
|
|
import { Refund } from './../Refunds.js';
|
|
import { Metadata } from '../../shared.js';
|
|
export interface Release {
|
|
/**
|
|
* Unique identifier for the object.
|
|
*/
|
|
id: string;
|
|
/**
|
|
* String representing the object's type. Objects of the same type share the same value.
|
|
*/
|
|
object: 'reserve.release';
|
|
/**
|
|
* Amount released. A positive integer representing how much is released in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
*/
|
|
amount: number;
|
|
/**
|
|
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
*/
|
|
created: number;
|
|
/**
|
|
* Indicates which party created this ReserveRelease.
|
|
*/
|
|
created_by: Reserve.Release.CreatedBy;
|
|
/**
|
|
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
*/
|
|
currency: string;
|
|
/**
|
|
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
|
|
*/
|
|
livemode: boolean;
|
|
/**
|
|
* Set of [key-value pairs](https://docs.stripe.com/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?: Metadata;
|
|
/**
|
|
* The reason for the ReserveRelease, indicating why the funds were released.
|
|
*/
|
|
reason: Reserve.Release.Reason;
|
|
/**
|
|
* The release timestamp of the funds.
|
|
*/
|
|
released_at: number;
|
|
/**
|
|
* The ReserveHold this ReserveRelease is associated with.
|
|
*/
|
|
reserve_hold: string | Hold | null;
|
|
/**
|
|
* The ReservePlan ID this ReserveRelease is associated with. This field is only populated if a ReserveRelease is created by a ReservePlan disable operation, or from a scheduled ReservedHold expiry.
|
|
*/
|
|
reserve_plan: string | Plan | null;
|
|
source_transaction?: Reserve.Release.SourceTransaction;
|
|
}
|
|
export declare namespace Reserve {
|
|
namespace Release {
|
|
type CreatedBy = 'application' | 'stripe';
|
|
type Reason = 'bulk_hold_expiry' | 'hold_released_early' | 'hold_reversed' | 'plan_disabled';
|
|
interface SourceTransaction {
|
|
/**
|
|
* The ID of the dispute.
|
|
*/
|
|
dispute?: string | Dispute;
|
|
/**
|
|
* The ID of the refund.
|
|
*/
|
|
refund?: string | Refund;
|
|
/**
|
|
* The type of source transaction.
|
|
*/
|
|
type: SourceTransaction.Type;
|
|
}
|
|
namespace SourceTransaction {
|
|
type Type = 'dispute' | 'refund';
|
|
}
|
|
}
|
|
}
|