Skip to content

New-AppStoreConnectSubscriptionIntroductoryOffer.md

Latest commit

 

History

History
252 lines (200 loc) · 5.48 KB

New-AppStoreConnectSubscriptionIntroductoryOffer.md

File metadata and controls

252 lines (200 loc) · 5.48 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

New-AppStoreConnectSubscriptionIntroductoryOffer

SYNOPSIS

Creates an App Store Connect introductory offer for an auto-renewable subscription.

SYNTAX

__AllParameterSets

New-AppStoreConnectSubscriptionIntroductoryOffer -IssuerId <string> -KeyId <string> -SubscriptionId <string> -Duration <AppStoreConnectSubscriptionOfferDuration> -OfferMode <AppStoreConnectSubscriptionOfferMode> -TerritoryId <string[]> [-PrivateKey <string>] [-PrivateKeyPath <string>] [-TokenLifetimeMinutes <int>] [-NumberOfPeriods <int>] [-StartDate <datetime>] [-EndDate <datetime>] [-SubscriptionPricePointId <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates an App Store Connect introductory offer for an auto-renewable subscription.

EXAMPLES

EXAMPLE 1

New-AppStoreConnectSubscriptionIntroductoryOffer -IssuerId 'Value' -KeyId 'Value' -SubscriptionId 'Value' -Duration 'Value' -OfferMode 'Value'

PARAMETERS

-Duration

Introductory-offer duration.

Type: AppStoreConnectSubscriptionOfferDuration
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: ThreeDays, OneWeek, TwoWeeks, OneMonth, TwoMonths, ThreeMonths, SixMonths, OneYear

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-EndDate

Optional offer end date.

Type: Nullable`1
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-IssuerId

Issuer ID from App Store Connect API keys.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-KeyId

Key ID associated with the private key.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-NumberOfPeriods

Number of offer periods.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-OfferMode

Introductory-offer payment mode.

Type: AppStoreConnectSubscriptionOfferMode
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: FreeTrial, PayAsYouGo, PayUpFront

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PrivateKey

Private key text in PEM format.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PrivateKeyPath

Path to a private key file in PEM format.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-StartDate

Optional offer start date.

Type: Nullable`1
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SubscriptionId

App Store Connect subscription resource id.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SubscriptionPricePointId

Subscription price point resource id for a paid offer. Paid offers accept one territory per invocation because App Store Connect price points are territory-specific.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TerritoryId

Territory resource ids for the offer. Free trials may target multiple territories; paid offers accept one.

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TokenLifetimeMinutes

Token lifetime in minutes, up to 20.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • None

OUTPUTS

  • PowerForge.AppStoreConnectSubscriptionIntroductoryOfferInfo

RELATED LINKS

  • None