Skip to main content

Subscriptions

Struct Subscriptions 

Source
pub struct Subscriptions { /* private fields */ }

Implementations§

Source§

impl Subscriptions

Source

pub fn instance_of<V: NapiRaw>(env: Env, value: V) -> Result<bool>

Source§

impl Subscriptions

Source§

impl Subscriptions

Source

pub async fn create_plan( &self, input: CreateSubscriptionPlanInput, ) -> Result<SubscriptionPlanOutput>

Create a new subscription plan

Source

pub async fn get_plan( &self, id: String, ) -> Result<Option<SubscriptionPlanOutput>>

Get a subscription plan by ID

Source

pub async fn get_plan_by_code( &self, code: String, ) -> Result<Option<SubscriptionPlanOutput>>

Get a subscription plan by code

Source

pub async fn list_plans( &self, filter: Option<SubscriptionPlanFilterInput>, ) -> Result<Vec<SubscriptionPlanOutput>>

List subscription plans

Source

pub async fn update_plan( &self, id: String, input: UpdateSubscriptionPlanInput, ) -> Result<SubscriptionPlanOutput>

Update a subscription plan

Source

pub async fn activate_plan(&self, id: String) -> Result<SubscriptionPlanOutput>

Activate a subscription plan

Source

pub async fn archive_plan(&self, id: String) -> Result<SubscriptionPlanOutput>

Archive a subscription plan

Source

pub async fn subscribe( &self, input: CreateSubscriptionInput, ) -> Result<SubscriptionOutput>

Create a subscription for a customer

Source

pub async fn get(&self, id: String) -> Result<Option<SubscriptionOutput>>

Get a subscription by ID

Source

pub async fn get_by_number( &self, number: String, ) -> Result<Option<SubscriptionOutput>>

Get a subscription by number

Source

pub async fn list( &self, filter: Option<SubscriptionFilterInput>, ) -> Result<Vec<SubscriptionOutput>>

List subscriptions

Source

pub async fn update( &self, id: String, input: UpdateSubscriptionInput, ) -> Result<SubscriptionOutput>

Update a subscription

Source

pub async fn pause( &self, id: String, input: Option<PauseSubscriptionInput>, ) -> Result<SubscriptionOutput>

Pause a subscription

Source

pub async fn resume(&self, id: String) -> Result<SubscriptionOutput>

Resume a paused subscription

Source

pub async fn cancel( &self, id: String, input: Option<CancelSubscriptionInput>, ) -> Result<SubscriptionOutput>

Cancel a subscription

Source

pub async fn skip_billing( &self, id: String, input: Option<SkipBillingCycleInput>, ) -> Result<SubscriptionOutput>

Skip the next billing cycle

Source

pub async fn list_billing_cycles( &self, filter: Option<BillingCycleFilterInput>, ) -> Result<Vec<BillingCycleOutput>>

List billing cycles for a subscription

Source

pub async fn get_billing_cycle( &self, id: String, ) -> Result<Option<BillingCycleOutput>>

Get a billing cycle by ID

Source

pub async fn get_events( &self, subscription_id: String, ) -> Result<Vec<SubscriptionEventOutput>>

Get events for a subscription

Trait Implementations§

Source§

impl FromNapiMutRef for Subscriptions

Source§

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

Safety Read more
Source§

impl FromNapiRef for Subscriptions

Source§

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

Safety Read more
Source§

impl FromNapiValue for &Subscriptions

Source§

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety Read more
Source§

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

Source§

impl FromNapiValue for &mut Subscriptions

Source§

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety Read more
Source§

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

Source§

impl ObjectFinalize for Subscriptions

Source§

fn finalize(self, env: Env) -> Result<(), Error>

Source§

impl ToNapiValue for Subscriptions

Source§

impl TypeName for &Subscriptions

Source§

impl TypeName for &mut Subscriptions

Source§

impl TypeName for Subscriptions

Source§

impl ValidateNapiValue for &Subscriptions

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more
Source§

impl ValidateNapiValue for &mut Subscriptions

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> JsValuesTupleIntoVec for T
where T: ToNapiValue,

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more