Network.Google.Resource.Reseller.Subscriptions.ChangePlan

Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.

See: Enterprise Apps Reseller API Reference for reseller.subscriptions.changePlan.

REST Resource

type SubscriptionsChangePlanResource = "apps" :> ("reseller" :> ("v1" :> ("customers" :> (Capture "customerId" Text :> ("subscriptions" :> (Capture "subscriptionId" Text :> ("changePlan" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ChangePlanRequest :> Post '[JSON] Subscription)))))))))

A resource alias for reseller.subscriptions.changePlan method which the SubscriptionsChangePlan request conforms to.

Creating a Request

subscriptionsChangePlan

Arguments

:: ChangePlanRequest

scpPayload

-> Text

scpCustomerId

-> Text

scpSubscriptionId

-> SubscriptionsChangePlan

Creates a value of SubscriptionsChangePlan with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• scpPayload
• scpCustomerId
• scpSubscriptionId

data SubscriptionsChangePlan

Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.

See: subscriptionsChangePlan smart constructor.

Instances

Eq SubscriptionsChangePlan

Defined in Network.Google.Resource.Reseller.Subscriptions.ChangePlan

Methods

(==) :: SubscriptionsChangePlan -> SubscriptionsChangePlan -> Bool

(/=) :: SubscriptionsChangePlan -> SubscriptionsChangePlan -> Bool

Data SubscriptionsChangePlan

Defined in Network.Google.Resource.Reseller.Subscriptions.ChangePlan

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubscriptionsChangePlan -> c SubscriptionsChangePlan

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubscriptionsChangePlan

toConstr :: SubscriptionsChangePlan -> Constr

dataTypeOf :: SubscriptionsChangePlan -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionsChangePlan)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubscriptionsChangePlan)

gmapT :: (forall b. Data b => b -> b) -> SubscriptionsChangePlan -> SubscriptionsChangePlan

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionsChangePlan -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionsChangePlan -> r

gmapQ :: (forall d. Data d => d -> u) -> SubscriptionsChangePlan -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubscriptionsChangePlan -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubscriptionsChangePlan -> m SubscriptionsChangePlan

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionsChangePlan -> m SubscriptionsChangePlan

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionsChangePlan -> m SubscriptionsChangePlan

Show SubscriptionsChangePlan

Defined in Network.Google.Resource.Reseller.Subscriptions.ChangePlan

Methods

showsPrec :: Int -> SubscriptionsChangePlan -> ShowS

show :: SubscriptionsChangePlan -> String

showList :: [SubscriptionsChangePlan] -> ShowS

Generic SubscriptionsChangePlan

Defined in Network.Google.Resource.Reseller.Subscriptions.ChangePlan

Associated Types

type Rep SubscriptionsChangePlan :: Type -> Type

Methods

from :: SubscriptionsChangePlan -> Rep SubscriptionsChangePlan x

to :: Rep SubscriptionsChangePlan x -> SubscriptionsChangePlan

GoogleRequest SubscriptionsChangePlan

Defined in Network.Google.Resource.Reseller.Subscriptions.ChangePlan

Associated Types

type Rs SubscriptionsChangePlan :: Type

type Scopes SubscriptionsChangePlan :: [Symbol]

Methods

requestClient :: SubscriptionsChangePlan -> GClient (Rs SubscriptionsChangePlan)

type Rep SubscriptionsChangePlan

Defined in Network.Google.Resource.Reseller.Subscriptions.ChangePlan

type Rep SubscriptionsChangePlan = D1 (MetaData "SubscriptionsChangePlan" "Network.Google.Resource.Reseller.Subscriptions.ChangePlan" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "SubscriptionsChangePlan'" PrefixI True) (S1 (MetaSel (Just "_scpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ChangePlanRequest) :*: (S1 (MetaSel (Just "_scpCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_scpSubscriptionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Scopes SubscriptionsChangePlan

Defined in Network.Google.Resource.Reseller.Subscriptions.ChangePlan

type Scopes SubscriptionsChangePlan = "https://www.googleapis.com/auth/apps.order" ': ([] :: [Symbol])

type Rs SubscriptionsChangePlan

Defined in Network.Google.Resource.Reseller.Subscriptions.ChangePlan

type Rs SubscriptionsChangePlan = Subscription

Request Lenses

scpPayload :: Lens' SubscriptionsChangePlan ChangePlanRequest

Multipart request metadata.

scpCustomerId :: Lens' SubscriptionsChangePlan Text

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

scpSubscriptionId :: Lens' SubscriptionsChangePlan Text

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.