pub struct Subscription {Show 17 fields
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>>,
}
Expand description
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§
Source§impl Clone for Subscription
impl Clone for Subscription
Source§fn clone(&self) -> Subscription
fn clone(&self) -> Subscription
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for Subscription
impl Debug for Subscription
Source§impl Default for Subscription
impl Default for Subscription
Source§fn default() -> Subscription
fn default() -> Subscription
Source§impl<'de> Deserialize<'de> for Subscription
impl<'de> Deserialize<'de> for Subscription
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for Subscription
impl PartialEq for Subscription
Source§impl Serialize for Subscription
impl Serialize for Subscription
impl Eq for Subscription
impl StructuralPartialEq for Subscription
Auto Trait Implementations§
impl Freeze for Subscription
impl RefUnwindSafe for Subscription
impl Send for Subscription
impl Sync for Subscription
impl Unpin for Subscription
impl UnwindSafe for Subscription
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.