Struct AddRecurringSubscriptionRequest

pub struct AddRecurringSubscriptionRequest {
    pub deal_id: i32,
    pub currency: String,
    pub description: Option<String>,
    pub cadence_type: CadenceType,
    pub cycles_count: Option<i32>,
    pub cycle_amount: i32,
    pub start_date: String,
    pub infinite: Option<bool>,
    pub payments: Option<Vec<Value>>,
    pub update_deal_value: Option<bool>,
}

Fields

deal_id: i32

The ID of the deal this recurring subscription is associated with

currency: String

The currency of the recurring subscription. Accepts a 3-character currency code.

description: Option<String>

The description of the recurring subscription

cadence_type: CadenceType

The interval between payments

cycles_count: Option<i32>

Shows how many payments the subscription has. Note that one field must be set: cycles_count or infinite. If cycles_count is set, then cycle_amount and start_date are also required.

cycle_amount: i32

The amount of each payment

start_date: String

The start date of the recurring subscription. Format: YYYY-MM-DD

infinite: Option<bool>

This indicates that the recurring subscription will last until it’s manually canceled or deleted. Note that only one field must be set: cycles_count or infinite.

payments: Option<Vec<Value>>

Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).

update_deal_value: Option<bool>

Indicates that the deal value must be set to recurring subscription’s MRR value

Implementations

impl AddRecurringSubscriptionRequest

pub fn new( deal_id: i32, currency: String, cadence_type: CadenceType, cycle_amount: i32, start_date: String, ) -> AddRecurringSubscriptionRequest

Trait Implementations

impl Clone for AddRecurringSubscriptionRequest

fn clone(&self) -> AddRecurringSubscriptionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddRecurringSubscriptionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AddRecurringSubscriptionRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AddRecurringSubscriptionRequest

fn eq(&self, other: &AddRecurringSubscriptionRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AddRecurringSubscriptionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AddRecurringSubscriptionRequest