Class: Nombaone::Resources::SubscriptionDunning

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/nombaone/resources/subscriptions.rb,
sig/nombaone/resources.rbs

Overview

Read-only view into a subscription's recovery state (nombaone.subscriptions.dunning).

Instance Method Summary collapse

Methods inherited from BaseResource

#encode, #initialize, #request, #request_page

Constructor Details

This class inherits a constructor from Nombaone::Resources::BaseResource

Instance Method Details

#list_attempts(subscription_id, limit: OMIT, cursor: OMIT, request_options: {}) ⇒ Page<NombaObject>

List every recovery attempt, newest first.

Parameters:

  • subscription_id (String) —

    nbo…sub

  • limit (Integer) (defaults to: OMIT) —

    page size, 1–100 (API default 20).

  • cursor (String) (defaults to: OMIT) —

    opaque cursor from a previous page.

  • request_options (Hash) (defaults to: {})

Returns:



67
68
69
70
 
# File 'lib/nombaone/resources/subscriptions.rb', line 67

def list_attempts(subscription_id, limit: OMIT, cursor: OMIT, request_options: {})
  request_page("/subscriptions/#{encode(subscription_id)}/dunning/attempts",
               query: { limit: limit, cursor: cursor }, options: request_options)
end

#retrieve(subscription_id, request_options: {}) ⇒ NombaObject

Where the subscription stands in dunning. Check grace_access_until before cutting access — past_due usually means "not yet", not "no".

Parameters:

  • subscription_id (String) —

    nbo…sub

  • request_options (Hash) (defaults to: {})
  • request_options: (Nombaone::request_options) (defaults to: {})

Returns:



56
57
58
 
# File 'lib/nombaone/resources/subscriptions.rb', line 56

def retrieve(subscription_id, request_options: {})
  request(:get, "/subscriptions/#{encode(subscription_id)}/dunning", options: request_options)
end