Struct Subscription

pub struct Subscription {

    pub id: Option<String>,
    pub location_id: Option<String>,
    pub plan_id: Option<String>,
    pub customer_id: Option<String>,
    pub start_date: Option<String>,
    pub canceled_date: Option<String>,
    pub charged_through_date: Option<String>,
    pub status: Option<SubscriptionStatus>,
    pub tax_percentage: Option<String>,
    pub invoice_ids: Option<Vec<String>>,
    pub price_override_money: Option<Money>,
    pub version: Option<i64>,
    pub create_at: Option<DateTime>,
    pub card_id: Option<String>,
    pub timezone: Option<Timezone>,
    pub source: Option<SubscriptionSource>,
    pub actions: Option<Vec<SubscriptionAction>>,
}

Represents a subscription to a subscription plan by a subscriber.

For an overview of the Subscription type, see Subscription object.

Fields

id: Option<String>

Read only The Square-assigned ID of the subscription.

Max Length: 255

location_id: Option<String>

Read only The ID of the location associated with the subscription.

plan_id: Option<String>

Read only The ID of the subscribed-to subscription plan.

customer_id: Option<String>

Read only The ID of the subscribing customer profile.

start_date: Option<String>

Read only The YYYY-MM-DD-formatted date (for example, 2013-01-15) to start the subscription.

canceled_date: Option<String>

The YYYY-MM-DD-formatted date (for example, 2013-01-15) to cancel the subscription, when the subscription status changes to CANCELED and the subscription billing stops.

If this field is not set, the subscription ends according its subscription plan.

This field cannot be updated, other than being cleared.

charged_through_date: Option<String>

Read only The YYYY-MM-DD-formatted date up to when the subscriber is invoiced for the subscription.

After the invoice is sent for a given billing period, this date will be the last day of the billing period. For example, suppose for the month of May a subscriber gets an invoice (or charged the card) on May 1. For the monthly billing scenario, this date is then set to May 31.

status: Option<SubscriptionStatus>

Read only The current status of the subscription.

tax_percentage: Option<String>

The tax amount applied when billing the subscription. The percentage is expressed in decimal form, using a '.' as the decimal separator and without a '%' sign. For example, a value of 7.5 corresponds to 7.5%.

invoice_ids: Option<Vec<String>>

Read only The IDs of the invoices created for the subscription, listed in order when the invoices were created (newest invoices appear first).

price_override_money: Option<Money>

A custom price to apply for the subscription. If specified, it overrides the price configured by the subscription plan.

version: Option<i64>

The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

create_at: Option<DateTime>

Read only The timestamp when the subscription was created, in RFC 3339 format.

card_id: Option<String>

The ID of the subscriber’s card used to charge for the subscription.

timezone: Option<Timezone>

Read only Timezone that will be used in date calculations for the subscription. Defaults to the timezone of the location based on location_id. Format: the IANA Timezone Database identifier for the location timezone (for example, America/Los_Angeles).

source: Option<SubscriptionSource>

The origination details of the subscription.

actions: Option<Vec<SubscriptionAction>>

The list of scheduled actions on this subscription. It is set only in the response from RetrieveSubscription with the query parameter of include=actions or from SearchSubscriptions with the input parameter of include:["actions"].

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl Default for Subscription

fn default() -> Subscription

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Subscription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Subscription

fn eq(&self, other: &Subscription) -> 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 Subscription

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 Subscription

impl StructuralPartialEq for Subscription