Files
sdk/docs/BillingSubscription.md

24 KiB

BillingSubscription

Properties

Name Type Description Notes
Assigned Pointer to []BillingSubscriptionSeat Assigned is which member holds which seat type, as the org's admin set it. [optional]
CancelAtPeriodEnd Pointer to bool CancelAtPeriodEnd reports that the plan ends at CurrentPeriodEnd. [optional]
CanceledAt Pointer to string CanceledAt is when it was canceled; absent when it was not. [optional]
ChargedCents Pointer to int64 ChargedCents is what the period in hand was actually paid, after any discount and net of refunds. 0 when the period is unpaid. [optional]
Coupon Pointer to string Coupon is the plan coupon code the first period was bought with, as commerce stores it (upper case); absent when none was. [optional]
CreatedAt Pointer to string CreatedAt is when the row was written, RFC 3339. [optional]
CurrentPeriodEnd Pointer to string CurrentPeriodEnd is when it ends, RFC 3339. The plan is paid through it. [optional]
CurrentPeriodStart Pointer to string CurrentPeriodStart is when the period in hand began, RFC 3339. [optional]
CustomerCents Pointer to int64 CustomerCents is the price staff agreed this subscriber pays for one seat each period, below the plan's list price; absent when none was. Every invoice bills the plan at list and the difference as the customer's discount. After LastPaid, for the ZAP wire. [optional]
DefaultPaymentMethod Pointer to string DefaultPaymentMethod is the saved method a renewal would use. Empty means there is none, so nothing can charge the plan. [optional]
EndedAt Pointer to string EndedAt is when it ended; absent while it runs. [optional]
Held Pointer to bool Held reports that this row is the subject's one paid plan: while it stands, commerce refuses a second paid sale (409). [optional]
Id Pointer to string ID is the subscription's own id, the one cancel and reactivate take. [optional]
LastPaid Pointer to string LastPaid is when the latest payment for this subscription arrived, RFC 3339: its latest paid invoice's paid time, or, for a period recorded as collected outside commerce, which keeps no time of its own record, the start of the latest period recorded — whichever is later. Any period, not only the one in hand: a plan past due still says when it was last paid. Empty when nothing was, or when the invoices did not read. Last, so every field before it keeps its place on the ZAP wire. [optional]
Lines Pointer to []BillingSubscriptionLine Lines are a team's other seat types beside Plan (a team of standard and premium seats is Plan "team" and one line of "team-premium"), each with the seats of it the period in hand was paid for. Seats above counts them too. After Held, so the fields before them keep their places on the ZAP wire. [optional]
MrrCents Pointer to int64 MRRCents is what this subscription contributes per month — commerce's own figure, interval-normalized and multiplied by its seats, so no reader re-derives it from price and interval. [optional]
Plan Pointer to BillingSubscriptionPlan Plan is the plan as this subscription snapshotted it. [optional]
PlanId Pointer to string PlanID is the plan slug, e.g. "max-20x". [optional]
ProviderType Pointer to string ProviderType is who collects it: a processor ("square"), "credit" for a plan bought with credits, "internal" or "bundle" for a row nobody paid for. [optional]
Quantity Pointer to int64 Quantity is the seat count; a flat plan holds 1. [optional]
Seats Pointer to int64 Seats is the seat count the period in hand was paid for — its paid invoice's quantity, or the quantity recorded with an external period — never the row's live Quantity, which the holder may change. 0 when the period is unpaid. [optional]
Settled Pointer to string Settled is how the period in hand was paid: &quot;card&quot; (a card paid all of it), &quot;external:<processor>&quot; (a payment recorded as collected outside commerce), &quot;balance&quot;, &quot;credit&quot; or &quot;mixed&quot; (prepaid money). Empty when unpaid or unknown. [optional]
Status Pointer to string Status is trialing, active, past_due, canceled or unpaid. Only active and trialing confer the plan. [optional]
Test Pointer to bool Test marks a sandbox subscription: sold while its org was in test mode, paid with sandbox money. It is listed and never revenue. [optional]
TrialEnd Pointer to string TrialEnd is when that trial ends; absent when there was none. [optional]
TrialStart Pointer to string TrialStart is when a trial began; absent when there was none. [optional]
UpdatedAt Pointer to string UpdatedAt is when the row last changed, RFC 3339. [optional]
UserId Pointer to string UserID is the billing account that holds it: the org slug for an org's own plan, &quot;<org>/<name>&quot; for a member's. [optional]

Methods

NewBillingSubscription

func NewBillingSubscription() *BillingSubscription

NewBillingSubscription instantiates a new BillingSubscription object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewBillingSubscriptionWithDefaults

func NewBillingSubscriptionWithDefaults() *BillingSubscription

NewBillingSubscriptionWithDefaults instantiates a new BillingSubscription object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetAssigned

func (o *BillingSubscription) GetAssigned() []BillingSubscriptionSeat

GetAssigned returns the Assigned field if non-nil, zero value otherwise.

GetAssignedOk

func (o *BillingSubscription) GetAssignedOk() (*[]BillingSubscriptionSeat, bool)

GetAssignedOk returns a tuple with the Assigned field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAssigned

func (o *BillingSubscription) SetAssigned(v []BillingSubscriptionSeat)

SetAssigned sets Assigned field to given value.

HasAssigned

func (o *BillingSubscription) HasAssigned() bool

HasAssigned returns a boolean if a field has been set.

GetCancelAtPeriodEnd

func (o *BillingSubscription) GetCancelAtPeriodEnd() bool

GetCancelAtPeriodEnd returns the CancelAtPeriodEnd field if non-nil, zero value otherwise.

GetCancelAtPeriodEndOk

func (o *BillingSubscription) GetCancelAtPeriodEndOk() (*bool, bool)

GetCancelAtPeriodEndOk returns a tuple with the CancelAtPeriodEnd field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCancelAtPeriodEnd

func (o *BillingSubscription) SetCancelAtPeriodEnd(v bool)

SetCancelAtPeriodEnd sets CancelAtPeriodEnd field to given value.

HasCancelAtPeriodEnd

func (o *BillingSubscription) HasCancelAtPeriodEnd() bool

HasCancelAtPeriodEnd returns a boolean if a field has been set.

GetCanceledAt

func (o *BillingSubscription) GetCanceledAt() string

GetCanceledAt returns the CanceledAt field if non-nil, zero value otherwise.

GetCanceledAtOk

func (o *BillingSubscription) GetCanceledAtOk() (*string, bool)

GetCanceledAtOk returns a tuple with the CanceledAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCanceledAt

func (o *BillingSubscription) SetCanceledAt(v string)

SetCanceledAt sets CanceledAt field to given value.

HasCanceledAt

func (o *BillingSubscription) HasCanceledAt() bool

HasCanceledAt returns a boolean if a field has been set.

GetChargedCents

func (o *BillingSubscription) GetChargedCents() int64

GetChargedCents returns the ChargedCents field if non-nil, zero value otherwise.

GetChargedCentsOk

func (o *BillingSubscription) GetChargedCentsOk() (*int64, bool)

GetChargedCentsOk returns a tuple with the ChargedCents field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetChargedCents

func (o *BillingSubscription) SetChargedCents(v int64)

SetChargedCents sets ChargedCents field to given value.

HasChargedCents

func (o *BillingSubscription) HasChargedCents() bool

HasChargedCents returns a boolean if a field has been set.

GetCoupon

func (o *BillingSubscription) GetCoupon() string

GetCoupon returns the Coupon field if non-nil, zero value otherwise.

GetCouponOk

func (o *BillingSubscription) GetCouponOk() (*string, bool)

GetCouponOk returns a tuple with the Coupon field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCoupon

func (o *BillingSubscription) SetCoupon(v string)

SetCoupon sets Coupon field to given value.

HasCoupon

func (o *BillingSubscription) HasCoupon() bool

HasCoupon returns a boolean if a field has been set.

GetCreatedAt

func (o *BillingSubscription) GetCreatedAt() string

GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise.

GetCreatedAtOk

func (o *BillingSubscription) GetCreatedAtOk() (*string, bool)

GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreatedAt

func (o *BillingSubscription) SetCreatedAt(v string)

SetCreatedAt sets CreatedAt field to given value.

HasCreatedAt

func (o *BillingSubscription) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

GetCurrentPeriodEnd

func (o *BillingSubscription) GetCurrentPeriodEnd() string

GetCurrentPeriodEnd returns the CurrentPeriodEnd field if non-nil, zero value otherwise.

GetCurrentPeriodEndOk

func (o *BillingSubscription) GetCurrentPeriodEndOk() (*string, bool)

GetCurrentPeriodEndOk returns a tuple with the CurrentPeriodEnd field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCurrentPeriodEnd

func (o *BillingSubscription) SetCurrentPeriodEnd(v string)

SetCurrentPeriodEnd sets CurrentPeriodEnd field to given value.

HasCurrentPeriodEnd

func (o *BillingSubscription) HasCurrentPeriodEnd() bool

HasCurrentPeriodEnd returns a boolean if a field has been set.

GetCurrentPeriodStart

func (o *BillingSubscription) GetCurrentPeriodStart() string

GetCurrentPeriodStart returns the CurrentPeriodStart field if non-nil, zero value otherwise.

GetCurrentPeriodStartOk

func (o *BillingSubscription) GetCurrentPeriodStartOk() (*string, bool)

GetCurrentPeriodStartOk returns a tuple with the CurrentPeriodStart field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCurrentPeriodStart

func (o *BillingSubscription) SetCurrentPeriodStart(v string)

SetCurrentPeriodStart sets CurrentPeriodStart field to given value.

HasCurrentPeriodStart

func (o *BillingSubscription) HasCurrentPeriodStart() bool

HasCurrentPeriodStart returns a boolean if a field has been set.

GetCustomerCents

func (o *BillingSubscription) GetCustomerCents() int64

GetCustomerCents returns the CustomerCents field if non-nil, zero value otherwise.

GetCustomerCentsOk

func (o *BillingSubscription) GetCustomerCentsOk() (*int64, bool)

GetCustomerCentsOk returns a tuple with the CustomerCents field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCustomerCents

func (o *BillingSubscription) SetCustomerCents(v int64)

SetCustomerCents sets CustomerCents field to given value.

HasCustomerCents

func (o *BillingSubscription) HasCustomerCents() bool

HasCustomerCents returns a boolean if a field has been set.

GetDefaultPaymentMethod

func (o *BillingSubscription) GetDefaultPaymentMethod() string

GetDefaultPaymentMethod returns the DefaultPaymentMethod field if non-nil, zero value otherwise.

GetDefaultPaymentMethodOk

func (o *BillingSubscription) GetDefaultPaymentMethodOk() (*string, bool)

GetDefaultPaymentMethodOk returns a tuple with the DefaultPaymentMethod field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDefaultPaymentMethod

func (o *BillingSubscription) SetDefaultPaymentMethod(v string)

SetDefaultPaymentMethod sets DefaultPaymentMethod field to given value.

HasDefaultPaymentMethod

func (o *BillingSubscription) HasDefaultPaymentMethod() bool

HasDefaultPaymentMethod returns a boolean if a field has been set.

GetEndedAt

func (o *BillingSubscription) GetEndedAt() string

GetEndedAt returns the EndedAt field if non-nil, zero value otherwise.

GetEndedAtOk

func (o *BillingSubscription) GetEndedAtOk() (*string, bool)

GetEndedAtOk returns a tuple with the EndedAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEndedAt

func (o *BillingSubscription) SetEndedAt(v string)

SetEndedAt sets EndedAt field to given value.

HasEndedAt

func (o *BillingSubscription) HasEndedAt() bool

HasEndedAt returns a boolean if a field has been set.

GetHeld

func (o *BillingSubscription) GetHeld() bool

GetHeld returns the Held field if non-nil, zero value otherwise.

GetHeldOk

func (o *BillingSubscription) GetHeldOk() (*bool, bool)

GetHeldOk returns a tuple with the Held field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHeld

func (o *BillingSubscription) SetHeld(v bool)

SetHeld sets Held field to given value.

HasHeld

func (o *BillingSubscription) HasHeld() bool

HasHeld returns a boolean if a field has been set.

GetId

func (o *BillingSubscription) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *BillingSubscription) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *BillingSubscription) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *BillingSubscription) HasId() bool

HasId returns a boolean if a field has been set.

GetLastPaid

func (o *BillingSubscription) GetLastPaid() string

GetLastPaid returns the LastPaid field if non-nil, zero value otherwise.

GetLastPaidOk

func (o *BillingSubscription) GetLastPaidOk() (*string, bool)

GetLastPaidOk returns a tuple with the LastPaid field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLastPaid

func (o *BillingSubscription) SetLastPaid(v string)

SetLastPaid sets LastPaid field to given value.

HasLastPaid

func (o *BillingSubscription) HasLastPaid() bool

HasLastPaid returns a boolean if a field has been set.

GetLines

func (o *BillingSubscription) GetLines() []BillingSubscriptionLine

GetLines returns the Lines field if non-nil, zero value otherwise.

GetLinesOk

func (o *BillingSubscription) GetLinesOk() (*[]BillingSubscriptionLine, bool)

GetLinesOk returns a tuple with the Lines field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLines

func (o *BillingSubscription) SetLines(v []BillingSubscriptionLine)

SetLines sets Lines field to given value.

HasLines

func (o *BillingSubscription) HasLines() bool

HasLines returns a boolean if a field has been set.

GetMrrCents

func (o *BillingSubscription) GetMrrCents() int64

GetMrrCents returns the MrrCents field if non-nil, zero value otherwise.

GetMrrCentsOk

func (o *BillingSubscription) GetMrrCentsOk() (*int64, bool)

GetMrrCentsOk returns a tuple with the MrrCents field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMrrCents

func (o *BillingSubscription) SetMrrCents(v int64)

SetMrrCents sets MrrCents field to given value.

HasMrrCents

func (o *BillingSubscription) HasMrrCents() bool

HasMrrCents returns a boolean if a field has been set.

GetPlan

func (o *BillingSubscription) GetPlan() BillingSubscriptionPlan

GetPlan returns the Plan field if non-nil, zero value otherwise.

GetPlanOk

func (o *BillingSubscription) GetPlanOk() (*BillingSubscriptionPlan, bool)

GetPlanOk returns a tuple with the Plan field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPlan

func (o *BillingSubscription) SetPlan(v BillingSubscriptionPlan)

SetPlan sets Plan field to given value.

HasPlan

func (o *BillingSubscription) HasPlan() bool

HasPlan returns a boolean if a field has been set.

GetPlanId

func (o *BillingSubscription) GetPlanId() string

GetPlanId returns the PlanId field if non-nil, zero value otherwise.

GetPlanIdOk

func (o *BillingSubscription) GetPlanIdOk() (*string, bool)

GetPlanIdOk returns a tuple with the PlanId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPlanId

func (o *BillingSubscription) SetPlanId(v string)

SetPlanId sets PlanId field to given value.

HasPlanId

func (o *BillingSubscription) HasPlanId() bool

HasPlanId returns a boolean if a field has been set.

GetProviderType

func (o *BillingSubscription) GetProviderType() string

GetProviderType returns the ProviderType field if non-nil, zero value otherwise.

GetProviderTypeOk

func (o *BillingSubscription) GetProviderTypeOk() (*string, bool)

GetProviderTypeOk returns a tuple with the ProviderType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProviderType

func (o *BillingSubscription) SetProviderType(v string)

SetProviderType sets ProviderType field to given value.

HasProviderType

func (o *BillingSubscription) HasProviderType() bool

HasProviderType returns a boolean if a field has been set.

GetQuantity

func (o *BillingSubscription) GetQuantity() int64

GetQuantity returns the Quantity field if non-nil, zero value otherwise.

GetQuantityOk

func (o *BillingSubscription) GetQuantityOk() (*int64, bool)

GetQuantityOk returns a tuple with the Quantity field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetQuantity

func (o *BillingSubscription) SetQuantity(v int64)

SetQuantity sets Quantity field to given value.

HasQuantity

func (o *BillingSubscription) HasQuantity() bool

HasQuantity returns a boolean if a field has been set.

GetSeats

func (o *BillingSubscription) GetSeats() int64

GetSeats returns the Seats field if non-nil, zero value otherwise.

GetSeatsOk

func (o *BillingSubscription) GetSeatsOk() (*int64, bool)

GetSeatsOk returns a tuple with the Seats field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSeats

func (o *BillingSubscription) SetSeats(v int64)

SetSeats sets Seats field to given value.

HasSeats

func (o *BillingSubscription) HasSeats() bool

HasSeats returns a boolean if a field has been set.

GetSettled

func (o *BillingSubscription) GetSettled() string

GetSettled returns the Settled field if non-nil, zero value otherwise.

GetSettledOk

func (o *BillingSubscription) GetSettledOk() (*string, bool)

GetSettledOk returns a tuple with the Settled field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSettled

func (o *BillingSubscription) SetSettled(v string)

SetSettled sets Settled field to given value.

HasSettled

func (o *BillingSubscription) HasSettled() bool

HasSettled returns a boolean if a field has been set.

GetStatus

func (o *BillingSubscription) GetStatus() string

GetStatus returns the Status field if non-nil, zero value otherwise.

GetStatusOk

func (o *BillingSubscription) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStatus

func (o *BillingSubscription) SetStatus(v string)

SetStatus sets Status field to given value.

HasStatus

func (o *BillingSubscription) HasStatus() bool

HasStatus returns a boolean if a field has been set.

GetTest

func (o *BillingSubscription) GetTest() bool

GetTest returns the Test field if non-nil, zero value otherwise.

GetTestOk

func (o *BillingSubscription) GetTestOk() (*bool, bool)

GetTestOk returns a tuple with the Test field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTest

func (o *BillingSubscription) SetTest(v bool)

SetTest sets Test field to given value.

HasTest

func (o *BillingSubscription) HasTest() bool

HasTest returns a boolean if a field has been set.

GetTrialEnd

func (o *BillingSubscription) GetTrialEnd() string

GetTrialEnd returns the TrialEnd field if non-nil, zero value otherwise.

GetTrialEndOk

func (o *BillingSubscription) GetTrialEndOk() (*string, bool)

GetTrialEndOk returns a tuple with the TrialEnd field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTrialEnd

func (o *BillingSubscription) SetTrialEnd(v string)

SetTrialEnd sets TrialEnd field to given value.

HasTrialEnd

func (o *BillingSubscription) HasTrialEnd() bool

HasTrialEnd returns a boolean if a field has been set.

GetTrialStart

func (o *BillingSubscription) GetTrialStart() string

GetTrialStart returns the TrialStart field if non-nil, zero value otherwise.

GetTrialStartOk

func (o *BillingSubscription) GetTrialStartOk() (*string, bool)

GetTrialStartOk returns a tuple with the TrialStart field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTrialStart

func (o *BillingSubscription) SetTrialStart(v string)

SetTrialStart sets TrialStart field to given value.

HasTrialStart

func (o *BillingSubscription) HasTrialStart() bool

HasTrialStart returns a boolean if a field has been set.

GetUpdatedAt

func (o *BillingSubscription) GetUpdatedAt() string

GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.

GetUpdatedAtOk

func (o *BillingSubscription) GetUpdatedAtOk() (*string, bool)

GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUpdatedAt

func (o *BillingSubscription) SetUpdatedAt(v string)

SetUpdatedAt sets UpdatedAt field to given value.

HasUpdatedAt

func (o *BillingSubscription) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

GetUserId

func (o *BillingSubscription) GetUserId() string

GetUserId returns the UserId field if non-nil, zero value otherwise.

GetUserIdOk

func (o *BillingSubscription) GetUserIdOk() (*string, bool)

GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUserId

func (o *BillingSubscription) SetUserId(v string)

SetUserId sets UserId field to given value.

HasUserId

func (o *BillingSubscription) HasUserId() bool

HasUserId returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]