Module: PaypalAPI::SubscriptionPlans::APIs

Included in:

PaypalAPI::SubscriptionPlans, PaypalAPI::SubscriptionPlans

Defined in:

lib/paypal-api/api_collections/subscription_plans.rb

Overview

Common methods for PaypalAPI::SubscriptionPlans class and client.subscription_plans instance

Instance Method Summary

• #activate(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

  Activate plan.

• #create(query: nil, body: nil, headers: nil) ⇒ Response

  Creates a plan that defines pricing and billing cycle details for subscriptions.

• #deactivate(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

  Deactivate plan.

• #list(query: nil, body: nil, headers: nil) ⇒ Response

  List plans.

• #show(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

  Show plan details.

• #update(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

  Update plan.

• #update_pricing(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

  Update pricing.

Instance Method Details

#activate(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

Activate plan

Parameters:

• plan_id (String) —

  Plan ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#plans_activate

# File 'lib/paypal-api/api_collections/subscription_plans.rb', line 74

def activate(plan_id, query: nil, body: nil, headers: nil)
  client.post("/v1/billing/plans/#{encode(plan_id)}/activate", query: query, body: body, headers: headers)
end

#create(query: nil, body: nil, headers: nil) ⇒ Response

Creates a plan that defines pricing and billing cycle details for subscriptions.

Parameters:

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#plans_create

# File 'lib/paypal-api/api_collections/subscription_plans.rb', line 27

def create(query: nil, body: nil, headers: nil)
  client.post("/v1/billing/plans", query: query, body: body, headers: headers)
end

#deactivate(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

Deactivate plan

Parameters:

• plan_id (String) —

  Plan ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#plans_deactivate

# File 'lib/paypal-api/api_collections/subscription_plans.rb', line 86

def deactivate(plan_id, query: nil, body: nil, headers: nil)
  client.post("/v1/billing/plans/#{encode(plan_id)}/deactivate", query: query, body: body, headers: headers)
end

#list(query: nil, body: nil, headers: nil) ⇒ Response

List plans

Parameters:

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#plans_list

# File 'lib/paypal-api/api_collections/subscription_plans.rb', line 38

def list(query: nil, body: nil, headers: nil)
  client.get("/v1/billing/plans", query: query, body: body, headers: headers)
end

#show(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

Show plan details

Parameters:

• plan_id (String) —

  Plan ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#plans_get

# File 'lib/paypal-api/api_collections/subscription_plans.rb', line 50

def show(plan_id, query: nil, body: nil, headers: nil)
  client.get("/v1/billing/plans/#{encode(plan_id)}", query: query, body: body, headers: headers)
end

#update(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

Update plan

Parameters:

• plan_id (String) —

  Plan ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#plans_patch

# File 'lib/paypal-api/api_collections/subscription_plans.rb', line 62

def update(plan_id, query: nil, body: nil, headers: nil)
  client.patch("/v1/billing/plans/#{encode(plan_id)}", query: query, body: body, headers: headers)
end

#update_pricing(plan_id, query: nil, body: nil, headers: nil) ⇒ Response

Update pricing

Parameters:

• plan_id (String) —

  Plan ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/subscriptions/v1/#plans_deactivate

# File 'lib/paypal-api/api_collections/subscription_plans.rb', line 98

def update_pricing(plan_id, query: nil, body: nil, headers: nil)
  client.post("/v1/billing/plans/#{encode(plan_id)}/update-pricing-schemes", query: query, body: body, headers: headers)
end