Skip to main content

CreateCustomerCommitV1BodyInvoiceSchedule

Struct CreateCustomerCommitV1BodyInvoiceSchedule 

Source
pub struct CreateCustomerCommitV1BodyInvoiceSchedule {
    pub credit_type_id: Option<Uuid>,
    pub do_not_invoice: bool,
    pub recurring_schedule: Option<CreateCustomerCommitV1BodyInvoiceScheduleRecurringSchedule>,
    pub schedule_items: Vec<CreateCustomerCommitV1BodyInvoiceScheduleScheduleItemsItem>,
}
Expand description

Required for “POSTPAID” commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match accesss_schedule amount. Optional for “PREPAID” commits: if not provided, this will be a “complimentary” commit with no invoice.

JSON schema
{
 "description": "Required for \"POSTPAID\" commits: the true up invoice
will be generated at this time and only one schedule item is allowed;
the total must match accesss_schedule amount. Optional for \"PREPAID\"
commits: if not provided, this will be a \"complimentary\" commit with
no invoice.",
 "type": "object",
 "properties": {
   "credit_type_id": {
     "description": "Defaults to USD (cents) if not passed.",
     "type": "string",
     "format": "uuid"
   },
   "do_not_invoice": {
     "description": "This field is only applicable to commit invoice
schedules. If true, this schedule will not generate an invoice.",
     "default": false,
     "type": "boolean"
   },
   "recurring_schedule": {
     "description": "Enter the unit price and quantity for the charge or
instead only send the amount. If amount is sent, the unit price is
assumed to be the amount and quantity is inferred to be 1.",
     "type": "object",
     "required": [
       "amount_distribution",
       "ending_before",
       "frequency",
       "starting_at"
     ],
     "properties": {
       "amount": {
         "description": "Amount for the charge. Can be provided instead
of unit_price and quantity. If amount is sent, the unit_price is assumed
to be the amount and quantity is inferred to be 1.",
         "type": "number"
       },
       "amount_distribution": {
         "type": "string"
       },
       "ending_before": {
         "description": "RFC 3339 timestamp (exclusive).",
         "type": "string",
         "format": "date-time"
       },
       "frequency": {
         "type": "string"
       },
       "quantity": {
         "description": "Quantity for the charge. Will be multiplied by
unit_price to determine the amount and must be specified with
unit_price. If specified amount cannot be provided.",
         "type": "number"
       },
       "starting_at": {
         "description": "RFC 3339 timestamp (inclusive).",
         "type": "string",
         "format": "date-time"
       },
       "unit_price": {
         "description": "Unit price for the charge. Will be multiplied
by quantity to determine the amount and must be specified with quantity.
If specified amount cannot be provided.",
         "type": "number"
       }
     }
   },
   "schedule_items": {
     "description": "Either provide amount or provide both unit_price
and quantity.",
     "type": "array",
     "items": {
       "type": "object",
       "required": [
         "timestamp"
       ],
       "properties": {
         "amount": {
           "description": "Amount for the charge. Can be provided
instead of unit_price and quantity. If amount is sent, the unit_price is
assumed to be the amount and quantity is inferred to be 1.",
           "type": "number"
         },
         "quantity": {
           "description": "Quantity for the charge. Will be multiplied
by unit_price to determine the amount and must be specified with
unit_price. If specified amount cannot be provided.",
           "type": "number"
         },
         "timestamp": {
           "description": "timestamp of the scheduled event",
           "type": "string",
           "format": "date-time"
         },
         "unit_price": {
           "description": "Unit price for the charge. Will be multiplied
by quantity to determine the amount and must be specified with quantity.
If specified amount cannot be provided.",
           "type": "number"
         }
       }
     }
   }
 }
}

Fields§

§credit_type_id: Option<Uuid>

Defaults to USD (cents) if not passed.

§do_not_invoice: bool

This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.

§recurring_schedule: Option<CreateCustomerCommitV1BodyInvoiceScheduleRecurringSchedule>§schedule_items: Vec<CreateCustomerCommitV1BodyInvoiceScheduleScheduleItemsItem>

Either provide amount or provide both unit_price and quantity.

Trait Implementations§

Source§

impl Clone for CreateCustomerCommitV1BodyInvoiceSchedule

Source§

fn clone(&self) -> CreateCustomerCommitV1BodyInvoiceSchedule

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateCustomerCommitV1BodyInvoiceSchedule

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CreateCustomerCommitV1BodyInvoiceSchedule

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CreateCustomerCommitV1BodyInvoiceSchedule

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CreateCustomerCommitV1BodyInvoiceSchedule

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more