Skip to main content

SubscriptionsClient

Struct SubscriptionsClient 

Source
pub struct SubscriptionsClient<'a> { /* private fields */ }
Expand description

Subscription endpoints. Obtain one from RazorpayClient::subscriptions.

Implementations§

Source§

impl<'a> SubscriptionsClient<'a>

Source

pub async fn create( &self, params: CreateSubscriptionParams, ) -> Result<Subscription, RazorpayError>

Create a subscription — POST /v1/subscriptions.

The returned Subscription::short_url is where the customer authorizes recurring charges; nothing is billed until they do.

Source

pub async fn fetch(&self, id: &str) -> Result<Subscription, RazorpayError>

Fetch one subscription by id — GET /v1/subscriptions/{id}.

Source

pub async fn all( &self, options: ListOptions, ) -> Result<Collection<Subscription>, RazorpayError>

List subscriptions — GET /v1/subscriptions.

Source

pub async fn cancel( &self, id: &str, at_cycle_end: bool, ) -> Result<Subscription, RazorpayError>

Cancel a subscription — POST /v1/subscriptions/{id}/cancel.

at_cycle_end of true lets the customer keep access through the period they already paid for; false cancels immediately.

Source

pub async fn pause(&self, id: &str) -> Result<Subscription, RazorpayError>

Pause a subscription — POST /v1/subscriptions/{id}/pause.

Charging stops until resume; the schedule is not extended.

Source

pub async fn resume(&self, id: &str) -> Result<Subscription, RazorpayError>

Resume a paused subscription — POST /v1/subscriptions/{id}/resume.

Source

pub async fn edit( &self, id: &str, notes: Notes, ) -> Result<Subscription, RazorpayError>

Replace a subscription’s notes — PATCH /v1/subscriptions/{id}.

Source

pub async fn invoices( &self, id: &str, ) -> Result<Collection<Invoice>, RazorpayError>

List invoices raised for a subscription — GET /v1/invoices?subscription_id={id}.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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