Struct square_api_client::models::PauseSubscriptionRequest

pub struct PauseSubscriptionRequest {
    pub pause_effective_date: Option<String>,
    pub pause_cycle_duration: Option<i64>,
    pub resume_effective_date: Option<String>,
    pub resume_change_timing: Option<ChangeTiming>,
    pub pause_reason: Option<String>,
}

This is the model struct for the PauseSubscriptionRequest type.

Fields

pause_effective_date: Option<String>

The YYYY-MM-DD-formatted date when the scheduled PAUSE action takes place on the subscription.

When this date is unspecified or falls within the current billing cycle, the subscription is paused on the starting date of the next billing cycle.

pause_cycle_duration: Option<i64>

The number of billing cycles the subscription will be paused before it is reactivated.

When this is set, a RESUME action is also scheduled to take place on the subscription at the end of the specified pause cycle duration. In this case, neither resume_effective_date nor resume_change_timing may be specified.

resume_effective_date: Option<String>

The date when the subscription is reactivated by a scheduled RESUME action. This date must be at least one billing cycle ahead of pause_effective_date.

resume_change_timing: Option<ChangeTiming>

The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to resume_effective_date.

pause_reason: Option<String>

The user-provided reason to pause the subscription.

Trait Implementations

impl Clone for PauseSubscriptionRequest

fn clone(&self) -> PauseSubscriptionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PauseSubscriptionRequest

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

Formats the value using the given formatter.

impl Default for PauseSubscriptionRequest

fn default() -> PauseSubscriptionRequest

Returns the “default value” for a type.

impl PartialEq<PauseSubscriptionRequest> for PauseSubscriptionRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for PauseSubscriptionRequest

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

Serialize this value into the given Serde serializer.

impl Eq for PauseSubscriptionRequest

impl StructuralEq for PauseSubscriptionRequest

impl StructuralPartialEq for PauseSubscriptionRequest