docusign_esign.models.account_billing_plan
Docusign eSignature REST API
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 Docusign eSignature REST API 5 6 The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class AccountBillingPlan(object): 23 """NOTE: This class is auto generated by the swagger code generator program. 24 25 Do not edit the class manually. 26 """ 27 28 """ 29 Attributes: 30 swagger_types (dict): The key is attribute name 31 and the value is attribute type. 32 attribute_map (dict): The key is attribute name 33 and the value is json key in definition. 34 """ 35 swagger_types = { 36 'add_ons': 'list[AddOn]', 37 'app_store_receipt_expiration_date': 'str', 38 'app_store_receipt_purchase_date': 'str', 39 'can_cancel_renewal': 'str', 40 'can_upgrade': 'str', 41 'currency_code': 'str', 42 'downgrade_plan_information': 'DowngradePlanUpdateResponse', 43 'enable_support': 'str', 44 'included_seats': 'str', 45 'incremental_seats': 'str', 46 'is_downgrade': 'str', 47 'notification_type': 'str', 48 'other_discount_percent': 'str', 49 'payment_cycle': 'str', 50 'payment_method': 'str', 51 'per_seat_price': 'str', 52 'plan_classification': 'str', 53 'plan_feature_sets': 'list[FeatureSet]', 54 'plan_id': 'str', 55 'plan_name': 'str', 56 'plan_start_date': 'str', 57 'product_id': 'str', 58 'renewal_date': 'str', 59 'renewal_status': 'str', 60 'seat_discounts': 'list[SeatDiscount]', 61 'subscription_start_date': 'str', 62 'support_incident_fee': 'str', 63 'support_plan_fee': 'str', 64 'tax_exempt_id': 'str' 65 } 66 67 attribute_map = { 68 'add_ons': 'addOns', 69 'app_store_receipt_expiration_date': 'appStoreReceiptExpirationDate', 70 'app_store_receipt_purchase_date': 'appStoreReceiptPurchaseDate', 71 'can_cancel_renewal': 'canCancelRenewal', 72 'can_upgrade': 'canUpgrade', 73 'currency_code': 'currencyCode', 74 'downgrade_plan_information': 'downgradePlanInformation', 75 'enable_support': 'enableSupport', 76 'included_seats': 'includedSeats', 77 'incremental_seats': 'incrementalSeats', 78 'is_downgrade': 'isDowngrade', 79 'notification_type': 'notificationType', 80 'other_discount_percent': 'otherDiscountPercent', 81 'payment_cycle': 'paymentCycle', 82 'payment_method': 'paymentMethod', 83 'per_seat_price': 'perSeatPrice', 84 'plan_classification': 'planClassification', 85 'plan_feature_sets': 'planFeatureSets', 86 'plan_id': 'planId', 87 'plan_name': 'planName', 88 'plan_start_date': 'planStartDate', 89 'product_id': 'productId', 90 'renewal_date': 'renewalDate', 91 'renewal_status': 'renewalStatus', 92 'seat_discounts': 'seatDiscounts', 93 'subscription_start_date': 'subscriptionStartDate', 94 'support_incident_fee': 'supportIncidentFee', 95 'support_plan_fee': 'supportPlanFee', 96 'tax_exempt_id': 'taxExemptId' 97 } 98 99 def __init__(self, _configuration=None, **kwargs): # noqa: E501 100 """AccountBillingPlan - a model defined in Swagger""" # noqa: E501 101 if _configuration is None: 102 _configuration = Configuration() 103 self._configuration = _configuration 104 105 self._add_ons = None 106 self._app_store_receipt_expiration_date = None 107 self._app_store_receipt_purchase_date = None 108 self._can_cancel_renewal = None 109 self._can_upgrade = None 110 self._currency_code = None 111 self._downgrade_plan_information = None 112 self._enable_support = None 113 self._included_seats = None 114 self._incremental_seats = None 115 self._is_downgrade = None 116 self._notification_type = None 117 self._other_discount_percent = None 118 self._payment_cycle = None 119 self._payment_method = None 120 self._per_seat_price = None 121 self._plan_classification = None 122 self._plan_feature_sets = None 123 self._plan_id = None 124 self._plan_name = None 125 self._plan_start_date = None 126 self._product_id = None 127 self._renewal_date = None 128 self._renewal_status = None 129 self._seat_discounts = None 130 self._subscription_start_date = None 131 self._support_incident_fee = None 132 self._support_plan_fee = None 133 self._tax_exempt_id = None 134 self.discriminator = None 135 136 setattr(self, "_{}".format('add_ons'), kwargs.get('add_ons', None)) 137 setattr(self, "_{}".format('app_store_receipt_expiration_date'), kwargs.get('app_store_receipt_expiration_date', None)) 138 setattr(self, "_{}".format('app_store_receipt_purchase_date'), kwargs.get('app_store_receipt_purchase_date', None)) 139 setattr(self, "_{}".format('can_cancel_renewal'), kwargs.get('can_cancel_renewal', None)) 140 setattr(self, "_{}".format('can_upgrade'), kwargs.get('can_upgrade', None)) 141 setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None)) 142 setattr(self, "_{}".format('downgrade_plan_information'), kwargs.get('downgrade_plan_information', None)) 143 setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None)) 144 setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None)) 145 setattr(self, "_{}".format('incremental_seats'), kwargs.get('incremental_seats', None)) 146 setattr(self, "_{}".format('is_downgrade'), kwargs.get('is_downgrade', None)) 147 setattr(self, "_{}".format('notification_type'), kwargs.get('notification_type', None)) 148 setattr(self, "_{}".format('other_discount_percent'), kwargs.get('other_discount_percent', None)) 149 setattr(self, "_{}".format('payment_cycle'), kwargs.get('payment_cycle', None)) 150 setattr(self, "_{}".format('payment_method'), kwargs.get('payment_method', None)) 151 setattr(self, "_{}".format('per_seat_price'), kwargs.get('per_seat_price', None)) 152 setattr(self, "_{}".format('plan_classification'), kwargs.get('plan_classification', None)) 153 setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None)) 154 setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None)) 155 setattr(self, "_{}".format('plan_name'), kwargs.get('plan_name', None)) 156 setattr(self, "_{}".format('plan_start_date'), kwargs.get('plan_start_date', None)) 157 setattr(self, "_{}".format('product_id'), kwargs.get('product_id', None)) 158 setattr(self, "_{}".format('renewal_date'), kwargs.get('renewal_date', None)) 159 setattr(self, "_{}".format('renewal_status'), kwargs.get('renewal_status', None)) 160 setattr(self, "_{}".format('seat_discounts'), kwargs.get('seat_discounts', None)) 161 setattr(self, "_{}".format('subscription_start_date'), kwargs.get('subscription_start_date', None)) 162 setattr(self, "_{}".format('support_incident_fee'), kwargs.get('support_incident_fee', None)) 163 setattr(self, "_{}".format('support_plan_fee'), kwargs.get('support_plan_fee', None)) 164 setattr(self, "_{}".format('tax_exempt_id'), kwargs.get('tax_exempt_id', None)) 165 166 @property 167 def add_ons(self): 168 """Gets the add_ons of this AccountBillingPlan. # noqa: E501 169 170 Reserved: # noqa: E501 171 172 :return: The add_ons of this AccountBillingPlan. # noqa: E501 173 :rtype: list[AddOn] 174 """ 175 return self._add_ons 176 177 @add_ons.setter 178 def add_ons(self, add_ons): 179 """Sets the add_ons of this AccountBillingPlan. 180 181 Reserved: # noqa: E501 182 183 :param add_ons: The add_ons of this AccountBillingPlan. # noqa: E501 184 :type: list[AddOn] 185 """ 186 187 self._add_ons = add_ons 188 189 @property 190 def app_store_receipt_expiration_date(self): 191 """Gets the app_store_receipt_expiration_date of this AccountBillingPlan. # noqa: E501 192 193 # noqa: E501 194 195 :return: The app_store_receipt_expiration_date of this AccountBillingPlan. # noqa: E501 196 :rtype: str 197 """ 198 return self._app_store_receipt_expiration_date 199 200 @app_store_receipt_expiration_date.setter 201 def app_store_receipt_expiration_date(self, app_store_receipt_expiration_date): 202 """Sets the app_store_receipt_expiration_date of this AccountBillingPlan. 203 204 # noqa: E501 205 206 :param app_store_receipt_expiration_date: The app_store_receipt_expiration_date of this AccountBillingPlan. # noqa: E501 207 :type: str 208 """ 209 210 self._app_store_receipt_expiration_date = app_store_receipt_expiration_date 211 212 @property 213 def app_store_receipt_purchase_date(self): 214 """Gets the app_store_receipt_purchase_date of this AccountBillingPlan. # noqa: E501 215 216 # noqa: E501 217 218 :return: The app_store_receipt_purchase_date of this AccountBillingPlan. # noqa: E501 219 :rtype: str 220 """ 221 return self._app_store_receipt_purchase_date 222 223 @app_store_receipt_purchase_date.setter 224 def app_store_receipt_purchase_date(self, app_store_receipt_purchase_date): 225 """Sets the app_store_receipt_purchase_date of this AccountBillingPlan. 226 227 # noqa: E501 228 229 :param app_store_receipt_purchase_date: The app_store_receipt_purchase_date of this AccountBillingPlan. # noqa: E501 230 :type: str 231 """ 232 233 self._app_store_receipt_purchase_date = app_store_receipt_purchase_date 234 235 @property 236 def can_cancel_renewal(self): 237 """Gets the can_cancel_renewal of this AccountBillingPlan. # noqa: E501 238 239 Reserved: TBD # noqa: E501 240 241 :return: The can_cancel_renewal of this AccountBillingPlan. # noqa: E501 242 :rtype: str 243 """ 244 return self._can_cancel_renewal 245 246 @can_cancel_renewal.setter 247 def can_cancel_renewal(self, can_cancel_renewal): 248 """Sets the can_cancel_renewal of this AccountBillingPlan. 249 250 Reserved: TBD # noqa: E501 251 252 :param can_cancel_renewal: The can_cancel_renewal of this AccountBillingPlan. # noqa: E501 253 :type: str 254 """ 255 256 self._can_cancel_renewal = can_cancel_renewal 257 258 @property 259 def can_upgrade(self): 260 """Gets the can_upgrade of this AccountBillingPlan. # noqa: E501 261 262 When set to **true**, specifies that you can upgrade the account through the API. # noqa: E501 263 264 :return: The can_upgrade of this AccountBillingPlan. # noqa: E501 265 :rtype: str 266 """ 267 return self._can_upgrade 268 269 @can_upgrade.setter 270 def can_upgrade(self, can_upgrade): 271 """Sets the can_upgrade of this AccountBillingPlan. 272 273 When set to **true**, specifies that you can upgrade the account through the API. # noqa: E501 274 275 :param can_upgrade: The can_upgrade of this AccountBillingPlan. # noqa: E501 276 :type: str 277 """ 278 279 self._can_upgrade = can_upgrade 280 281 @property 282 def currency_code(self): 283 """Gets the currency_code of this AccountBillingPlan. # noqa: E501 284 285 Specifies the ISO currency code for the account. # noqa: E501 286 287 :return: The currency_code of this AccountBillingPlan. # noqa: E501 288 :rtype: str 289 """ 290 return self._currency_code 291 292 @currency_code.setter 293 def currency_code(self, currency_code): 294 """Sets the currency_code of this AccountBillingPlan. 295 296 Specifies the ISO currency code for the account. # noqa: E501 297 298 :param currency_code: The currency_code of this AccountBillingPlan. # noqa: E501 299 :type: str 300 """ 301 302 self._currency_code = currency_code 303 304 @property 305 def downgrade_plan_information(self): 306 """Gets the downgrade_plan_information of this AccountBillingPlan. # noqa: E501 307 308 # noqa: E501 309 310 :return: The downgrade_plan_information of this AccountBillingPlan. # noqa: E501 311 :rtype: DowngradePlanUpdateResponse 312 """ 313 return self._downgrade_plan_information 314 315 @downgrade_plan_information.setter 316 def downgrade_plan_information(self, downgrade_plan_information): 317 """Sets the downgrade_plan_information of this AccountBillingPlan. 318 319 # noqa: E501 320 321 :param downgrade_plan_information: The downgrade_plan_information of this AccountBillingPlan. # noqa: E501 322 :type: DowngradePlanUpdateResponse 323 """ 324 325 self._downgrade_plan_information = downgrade_plan_information 326 327 @property 328 def enable_support(self): 329 """Gets the enable_support of this AccountBillingPlan. # noqa: E501 330 331 When set to **true**, then customer support is provided as part of the account plan. # noqa: E501 332 333 :return: The enable_support of this AccountBillingPlan. # noqa: E501 334 :rtype: str 335 """ 336 return self._enable_support 337 338 @enable_support.setter 339 def enable_support(self, enable_support): 340 """Sets the enable_support of this AccountBillingPlan. 341 342 When set to **true**, then customer support is provided as part of the account plan. # noqa: E501 343 344 :param enable_support: The enable_support of this AccountBillingPlan. # noqa: E501 345 :type: str 346 """ 347 348 self._enable_support = enable_support 349 350 @property 351 def included_seats(self): 352 """Gets the included_seats of this AccountBillingPlan. # noqa: E501 353 354 The number of seats (users) included. # noqa: E501 355 356 :return: The included_seats of this AccountBillingPlan. # noqa: E501 357 :rtype: str 358 """ 359 return self._included_seats 360 361 @included_seats.setter 362 def included_seats(self, included_seats): 363 """Sets the included_seats of this AccountBillingPlan. 364 365 The number of seats (users) included. # noqa: E501 366 367 :param included_seats: The included_seats of this AccountBillingPlan. # noqa: E501 368 :type: str 369 """ 370 371 self._included_seats = included_seats 372 373 @property 374 def incremental_seats(self): 375 """Gets the incremental_seats of this AccountBillingPlan. # noqa: E501 376 377 Reserved: TBD # noqa: E501 378 379 :return: The incremental_seats of this AccountBillingPlan. # noqa: E501 380 :rtype: str 381 """ 382 return self._incremental_seats 383 384 @incremental_seats.setter 385 def incremental_seats(self, incremental_seats): 386 """Sets the incremental_seats of this AccountBillingPlan. 387 388 Reserved: TBD # noqa: E501 389 390 :param incremental_seats: The incremental_seats of this AccountBillingPlan. # noqa: E501 391 :type: str 392 """ 393 394 self._incremental_seats = incremental_seats 395 396 @property 397 def is_downgrade(self): 398 """Gets the is_downgrade of this AccountBillingPlan. # noqa: E501 399 400 # noqa: E501 401 402 :return: The is_downgrade of this AccountBillingPlan. # noqa: E501 403 :rtype: str 404 """ 405 return self._is_downgrade 406 407 @is_downgrade.setter 408 def is_downgrade(self, is_downgrade): 409 """Sets the is_downgrade of this AccountBillingPlan. 410 411 # noqa: E501 412 413 :param is_downgrade: The is_downgrade of this AccountBillingPlan. # noqa: E501 414 :type: str 415 """ 416 417 self._is_downgrade = is_downgrade 418 419 @property 420 def notification_type(self): 421 """Gets the notification_type of this AccountBillingPlan. # noqa: E501 422 423 # noqa: E501 424 425 :return: The notification_type of this AccountBillingPlan. # noqa: E501 426 :rtype: str 427 """ 428 return self._notification_type 429 430 @notification_type.setter 431 def notification_type(self, notification_type): 432 """Sets the notification_type of this AccountBillingPlan. 433 434 # noqa: E501 435 436 :param notification_type: The notification_type of this AccountBillingPlan. # noqa: E501 437 :type: str 438 """ 439 440 self._notification_type = notification_type 441 442 @property 443 def other_discount_percent(self): 444 """Gets the other_discount_percent of this AccountBillingPlan. # noqa: E501 445 446 Any other percentage discount for the plan. # noqa: E501 447 448 :return: The other_discount_percent of this AccountBillingPlan. # noqa: E501 449 :rtype: str 450 """ 451 return self._other_discount_percent 452 453 @other_discount_percent.setter 454 def other_discount_percent(self, other_discount_percent): 455 """Sets the other_discount_percent of this AccountBillingPlan. 456 457 Any other percentage discount for the plan. # noqa: E501 458 459 :param other_discount_percent: The other_discount_percent of this AccountBillingPlan. # noqa: E501 460 :type: str 461 """ 462 463 self._other_discount_percent = other_discount_percent 464 465 @property 466 def payment_cycle(self): 467 """Gets the payment_cycle of this AccountBillingPlan. # noqa: E501 468 469 # noqa: E501 470 471 :return: The payment_cycle of this AccountBillingPlan. # noqa: E501 472 :rtype: str 473 """ 474 return self._payment_cycle 475 476 @payment_cycle.setter 477 def payment_cycle(self, payment_cycle): 478 """Sets the payment_cycle of this AccountBillingPlan. 479 480 # noqa: E501 481 482 :param payment_cycle: The payment_cycle of this AccountBillingPlan. # noqa: E501 483 :type: str 484 """ 485 486 self._payment_cycle = payment_cycle 487 488 @property 489 def payment_method(self): 490 """Gets the payment_method of this AccountBillingPlan. # noqa: E501 491 492 The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. # noqa: E501 493 494 :return: The payment_method of this AccountBillingPlan. # noqa: E501 495 :rtype: str 496 """ 497 return self._payment_method 498 499 @payment_method.setter 500 def payment_method(self, payment_method): 501 """Sets the payment_method of this AccountBillingPlan. 502 503 The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. # noqa: E501 504 505 :param payment_method: The payment_method of this AccountBillingPlan. # noqa: E501 506 :type: str 507 """ 508 509 self._payment_method = payment_method 510 511 @property 512 def per_seat_price(self): 513 """Gets the per_seat_price of this AccountBillingPlan. # noqa: E501 514 515 # noqa: E501 516 517 :return: The per_seat_price of this AccountBillingPlan. # noqa: E501 518 :rtype: str 519 """ 520 return self._per_seat_price 521 522 @per_seat_price.setter 523 def per_seat_price(self, per_seat_price): 524 """Sets the per_seat_price of this AccountBillingPlan. 525 526 # noqa: E501 527 528 :param per_seat_price: The per_seat_price of this AccountBillingPlan. # noqa: E501 529 :type: str 530 """ 531 532 self._per_seat_price = per_seat_price 533 534 @property 535 def plan_classification(self): 536 """Gets the plan_classification of this AccountBillingPlan. # noqa: E501 537 538 Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. # noqa: E501 539 540 :return: The plan_classification of this AccountBillingPlan. # noqa: E501 541 :rtype: str 542 """ 543 return self._plan_classification 544 545 @plan_classification.setter 546 def plan_classification(self, plan_classification): 547 """Sets the plan_classification of this AccountBillingPlan. 548 549 Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. # noqa: E501 550 551 :param plan_classification: The plan_classification of this AccountBillingPlan. # noqa: E501 552 :type: str 553 """ 554 555 self._plan_classification = plan_classification 556 557 @property 558 def plan_feature_sets(self): 559 """Gets the plan_feature_sets of this AccountBillingPlan. # noqa: E501 560 561 A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). # noqa: E501 562 563 :return: The plan_feature_sets of this AccountBillingPlan. # noqa: E501 564 :rtype: list[FeatureSet] 565 """ 566 return self._plan_feature_sets 567 568 @plan_feature_sets.setter 569 def plan_feature_sets(self, plan_feature_sets): 570 """Sets the plan_feature_sets of this AccountBillingPlan. 571 572 A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). # noqa: E501 573 574 :param plan_feature_sets: The plan_feature_sets of this AccountBillingPlan. # noqa: E501 575 :type: list[FeatureSet] 576 """ 577 578 self._plan_feature_sets = plan_feature_sets 579 580 @property 581 def plan_id(self): 582 """Gets the plan_id of this AccountBillingPlan. # noqa: E501 583 584 # noqa: E501 585 586 :return: The plan_id of this AccountBillingPlan. # noqa: E501 587 :rtype: str 588 """ 589 return self._plan_id 590 591 @plan_id.setter 592 def plan_id(self, plan_id): 593 """Sets the plan_id of this AccountBillingPlan. 594 595 # noqa: E501 596 597 :param plan_id: The plan_id of this AccountBillingPlan. # noqa: E501 598 :type: str 599 """ 600 601 self._plan_id = plan_id 602 603 @property 604 def plan_name(self): 605 """Gets the plan_name of this AccountBillingPlan. # noqa: E501 606 607 The name of the Billing Plan. # noqa: E501 608 609 :return: The plan_name of this AccountBillingPlan. # noqa: E501 610 :rtype: str 611 """ 612 return self._plan_name 613 614 @plan_name.setter 615 def plan_name(self, plan_name): 616 """Sets the plan_name of this AccountBillingPlan. 617 618 The name of the Billing Plan. # noqa: E501 619 620 :param plan_name: The plan_name of this AccountBillingPlan. # noqa: E501 621 :type: str 622 """ 623 624 self._plan_name = plan_name 625 626 @property 627 def plan_start_date(self): 628 """Gets the plan_start_date of this AccountBillingPlan. # noqa: E501 629 630 # noqa: E501 631 632 :return: The plan_start_date of this AccountBillingPlan. # noqa: E501 633 :rtype: str 634 """ 635 return self._plan_start_date 636 637 @plan_start_date.setter 638 def plan_start_date(self, plan_start_date): 639 """Sets the plan_start_date of this AccountBillingPlan. 640 641 # noqa: E501 642 643 :param plan_start_date: The plan_start_date of this AccountBillingPlan. # noqa: E501 644 :type: str 645 """ 646 647 self._plan_start_date = plan_start_date 648 649 @property 650 def product_id(self): 651 """Gets the product_id of this AccountBillingPlan. # noqa: E501 652 653 # noqa: E501 654 655 :return: The product_id of this AccountBillingPlan. # noqa: E501 656 :rtype: str 657 """ 658 return self._product_id 659 660 @product_id.setter 661 def product_id(self, product_id): 662 """Sets the product_id of this AccountBillingPlan. 663 664 # noqa: E501 665 666 :param product_id: The product_id of this AccountBillingPlan. # noqa: E501 667 :type: str 668 """ 669 670 self._product_id = product_id 671 672 @property 673 def renewal_date(self): 674 """Gets the renewal_date of this AccountBillingPlan. # noqa: E501 675 676 # noqa: E501 677 678 :return: The renewal_date of this AccountBillingPlan. # noqa: E501 679 :rtype: str 680 """ 681 return self._renewal_date 682 683 @renewal_date.setter 684 def renewal_date(self, renewal_date): 685 """Sets the renewal_date of this AccountBillingPlan. 686 687 # noqa: E501 688 689 :param renewal_date: The renewal_date of this AccountBillingPlan. # noqa: E501 690 :type: str 691 """ 692 693 self._renewal_date = renewal_date 694 695 @property 696 def renewal_status(self): 697 """Gets the renewal_status of this AccountBillingPlan. # noqa: E501 698 699 The renewal status for the account. The acceptable values are: * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate. # noqa: E501 700 701 :return: The renewal_status of this AccountBillingPlan. # noqa: E501 702 :rtype: str 703 """ 704 return self._renewal_status 705 706 @renewal_status.setter 707 def renewal_status(self, renewal_status): 708 """Sets the renewal_status of this AccountBillingPlan. 709 710 The renewal status for the account. The acceptable values are: * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate. # noqa: E501 711 712 :param renewal_status: The renewal_status of this AccountBillingPlan. # noqa: E501 713 :type: str 714 """ 715 716 self._renewal_status = renewal_status 717 718 @property 719 def seat_discounts(self): 720 """Gets the seat_discounts of this AccountBillingPlan. # noqa: E501 721 722 A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. # noqa: E501 723 724 :return: The seat_discounts of this AccountBillingPlan. # noqa: E501 725 :rtype: list[SeatDiscount] 726 """ 727 return self._seat_discounts 728 729 @seat_discounts.setter 730 def seat_discounts(self, seat_discounts): 731 """Sets the seat_discounts of this AccountBillingPlan. 732 733 A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. # noqa: E501 734 735 :param seat_discounts: The seat_discounts of this AccountBillingPlan. # noqa: E501 736 :type: list[SeatDiscount] 737 """ 738 739 self._seat_discounts = seat_discounts 740 741 @property 742 def subscription_start_date(self): 743 """Gets the subscription_start_date of this AccountBillingPlan. # noqa: E501 744 745 # noqa: E501 746 747 :return: The subscription_start_date of this AccountBillingPlan. # noqa: E501 748 :rtype: str 749 """ 750 return self._subscription_start_date 751 752 @subscription_start_date.setter 753 def subscription_start_date(self, subscription_start_date): 754 """Sets the subscription_start_date of this AccountBillingPlan. 755 756 # noqa: E501 757 758 :param subscription_start_date: The subscription_start_date of this AccountBillingPlan. # noqa: E501 759 :type: str 760 """ 761 762 self._subscription_start_date = subscription_start_date 763 764 @property 765 def support_incident_fee(self): 766 """Gets the support_incident_fee of this AccountBillingPlan. # noqa: E501 767 768 The support incident fee charged for each support incident. # noqa: E501 769 770 :return: The support_incident_fee of this AccountBillingPlan. # noqa: E501 771 :rtype: str 772 """ 773 return self._support_incident_fee 774 775 @support_incident_fee.setter 776 def support_incident_fee(self, support_incident_fee): 777 """Sets the support_incident_fee of this AccountBillingPlan. 778 779 The support incident fee charged for each support incident. # noqa: E501 780 781 :param support_incident_fee: The support_incident_fee of this AccountBillingPlan. # noqa: E501 782 :type: str 783 """ 784 785 self._support_incident_fee = support_incident_fee 786 787 @property 788 def support_plan_fee(self): 789 """Gets the support_plan_fee of this AccountBillingPlan. # noqa: E501 790 791 The support plan fee charged for this plan. # noqa: E501 792 793 :return: The support_plan_fee of this AccountBillingPlan. # noqa: E501 794 :rtype: str 795 """ 796 return self._support_plan_fee 797 798 @support_plan_fee.setter 799 def support_plan_fee(self, support_plan_fee): 800 """Sets the support_plan_fee of this AccountBillingPlan. 801 802 The support plan fee charged for this plan. # noqa: E501 803 804 :param support_plan_fee: The support_plan_fee of this AccountBillingPlan. # noqa: E501 805 :type: str 806 """ 807 808 self._support_plan_fee = support_plan_fee 809 810 @property 811 def tax_exempt_id(self): 812 """Gets the tax_exempt_id of this AccountBillingPlan. # noqa: E501 813 814 # noqa: E501 815 816 :return: The tax_exempt_id of this AccountBillingPlan. # noqa: E501 817 :rtype: str 818 """ 819 return self._tax_exempt_id 820 821 @tax_exempt_id.setter 822 def tax_exempt_id(self, tax_exempt_id): 823 """Sets the tax_exempt_id of this AccountBillingPlan. 824 825 # noqa: E501 826 827 :param tax_exempt_id: The tax_exempt_id of this AccountBillingPlan. # noqa: E501 828 :type: str 829 """ 830 831 self._tax_exempt_id = tax_exempt_id 832 833 def to_dict(self): 834 """Returns the model properties as a dict""" 835 result = {} 836 837 for attr, _ in six.iteritems(self.swagger_types): 838 value = getattr(self, attr) 839 if isinstance(value, list): 840 result[attr] = list(map( 841 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 842 value 843 )) 844 elif hasattr(value, "to_dict"): 845 result[attr] = value.to_dict() 846 elif isinstance(value, dict): 847 result[attr] = dict(map( 848 lambda item: (item[0], item[1].to_dict()) 849 if hasattr(item[1], "to_dict") else item, 850 value.items() 851 )) 852 else: 853 result[attr] = value 854 if issubclass(AccountBillingPlan, dict): 855 for key, value in self.items(): 856 result[key] = value 857 858 return result 859 860 def to_str(self): 861 """Returns the string representation of the model""" 862 return pprint.pformat(self.to_dict()) 863 864 def __repr__(self): 865 """For `print` and `pprint`""" 866 return self.to_str() 867 868 def __eq__(self, other): 869 """Returns true if both objects are equal""" 870 if not isinstance(other, AccountBillingPlan): 871 return False 872 873 return self.to_dict() == other.to_dict() 874 875 def __ne__(self, other): 876 """Returns true if both objects are not equal""" 877 if not isinstance(other, AccountBillingPlan): 878 return True 879 880 return self.to_dict() != other.to_dict()
23class AccountBillingPlan(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'add_ons': 'list[AddOn]', 38 'app_store_receipt_expiration_date': 'str', 39 'app_store_receipt_purchase_date': 'str', 40 'can_cancel_renewal': 'str', 41 'can_upgrade': 'str', 42 'currency_code': 'str', 43 'downgrade_plan_information': 'DowngradePlanUpdateResponse', 44 'enable_support': 'str', 45 'included_seats': 'str', 46 'incremental_seats': 'str', 47 'is_downgrade': 'str', 48 'notification_type': 'str', 49 'other_discount_percent': 'str', 50 'payment_cycle': 'str', 51 'payment_method': 'str', 52 'per_seat_price': 'str', 53 'plan_classification': 'str', 54 'plan_feature_sets': 'list[FeatureSet]', 55 'plan_id': 'str', 56 'plan_name': 'str', 57 'plan_start_date': 'str', 58 'product_id': 'str', 59 'renewal_date': 'str', 60 'renewal_status': 'str', 61 'seat_discounts': 'list[SeatDiscount]', 62 'subscription_start_date': 'str', 63 'support_incident_fee': 'str', 64 'support_plan_fee': 'str', 65 'tax_exempt_id': 'str' 66 } 67 68 attribute_map = { 69 'add_ons': 'addOns', 70 'app_store_receipt_expiration_date': 'appStoreReceiptExpirationDate', 71 'app_store_receipt_purchase_date': 'appStoreReceiptPurchaseDate', 72 'can_cancel_renewal': 'canCancelRenewal', 73 'can_upgrade': 'canUpgrade', 74 'currency_code': 'currencyCode', 75 'downgrade_plan_information': 'downgradePlanInformation', 76 'enable_support': 'enableSupport', 77 'included_seats': 'includedSeats', 78 'incremental_seats': 'incrementalSeats', 79 'is_downgrade': 'isDowngrade', 80 'notification_type': 'notificationType', 81 'other_discount_percent': 'otherDiscountPercent', 82 'payment_cycle': 'paymentCycle', 83 'payment_method': 'paymentMethod', 84 'per_seat_price': 'perSeatPrice', 85 'plan_classification': 'planClassification', 86 'plan_feature_sets': 'planFeatureSets', 87 'plan_id': 'planId', 88 'plan_name': 'planName', 89 'plan_start_date': 'planStartDate', 90 'product_id': 'productId', 91 'renewal_date': 'renewalDate', 92 'renewal_status': 'renewalStatus', 93 'seat_discounts': 'seatDiscounts', 94 'subscription_start_date': 'subscriptionStartDate', 95 'support_incident_fee': 'supportIncidentFee', 96 'support_plan_fee': 'supportPlanFee', 97 'tax_exempt_id': 'taxExemptId' 98 } 99 100 def __init__(self, _configuration=None, **kwargs): # noqa: E501 101 """AccountBillingPlan - a model defined in Swagger""" # noqa: E501 102 if _configuration is None: 103 _configuration = Configuration() 104 self._configuration = _configuration 105 106 self._add_ons = None 107 self._app_store_receipt_expiration_date = None 108 self._app_store_receipt_purchase_date = None 109 self._can_cancel_renewal = None 110 self._can_upgrade = None 111 self._currency_code = None 112 self._downgrade_plan_information = None 113 self._enable_support = None 114 self._included_seats = None 115 self._incremental_seats = None 116 self._is_downgrade = None 117 self._notification_type = None 118 self._other_discount_percent = None 119 self._payment_cycle = None 120 self._payment_method = None 121 self._per_seat_price = None 122 self._plan_classification = None 123 self._plan_feature_sets = None 124 self._plan_id = None 125 self._plan_name = None 126 self._plan_start_date = None 127 self._product_id = None 128 self._renewal_date = None 129 self._renewal_status = None 130 self._seat_discounts = None 131 self._subscription_start_date = None 132 self._support_incident_fee = None 133 self._support_plan_fee = None 134 self._tax_exempt_id = None 135 self.discriminator = None 136 137 setattr(self, "_{}".format('add_ons'), kwargs.get('add_ons', None)) 138 setattr(self, "_{}".format('app_store_receipt_expiration_date'), kwargs.get('app_store_receipt_expiration_date', None)) 139 setattr(self, "_{}".format('app_store_receipt_purchase_date'), kwargs.get('app_store_receipt_purchase_date', None)) 140 setattr(self, "_{}".format('can_cancel_renewal'), kwargs.get('can_cancel_renewal', None)) 141 setattr(self, "_{}".format('can_upgrade'), kwargs.get('can_upgrade', None)) 142 setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None)) 143 setattr(self, "_{}".format('downgrade_plan_information'), kwargs.get('downgrade_plan_information', None)) 144 setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None)) 145 setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None)) 146 setattr(self, "_{}".format('incremental_seats'), kwargs.get('incremental_seats', None)) 147 setattr(self, "_{}".format('is_downgrade'), kwargs.get('is_downgrade', None)) 148 setattr(self, "_{}".format('notification_type'), kwargs.get('notification_type', None)) 149 setattr(self, "_{}".format('other_discount_percent'), kwargs.get('other_discount_percent', None)) 150 setattr(self, "_{}".format('payment_cycle'), kwargs.get('payment_cycle', None)) 151 setattr(self, "_{}".format('payment_method'), kwargs.get('payment_method', None)) 152 setattr(self, "_{}".format('per_seat_price'), kwargs.get('per_seat_price', None)) 153 setattr(self, "_{}".format('plan_classification'), kwargs.get('plan_classification', None)) 154 setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None)) 155 setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None)) 156 setattr(self, "_{}".format('plan_name'), kwargs.get('plan_name', None)) 157 setattr(self, "_{}".format('plan_start_date'), kwargs.get('plan_start_date', None)) 158 setattr(self, "_{}".format('product_id'), kwargs.get('product_id', None)) 159 setattr(self, "_{}".format('renewal_date'), kwargs.get('renewal_date', None)) 160 setattr(self, "_{}".format('renewal_status'), kwargs.get('renewal_status', None)) 161 setattr(self, "_{}".format('seat_discounts'), kwargs.get('seat_discounts', None)) 162 setattr(self, "_{}".format('subscription_start_date'), kwargs.get('subscription_start_date', None)) 163 setattr(self, "_{}".format('support_incident_fee'), kwargs.get('support_incident_fee', None)) 164 setattr(self, "_{}".format('support_plan_fee'), kwargs.get('support_plan_fee', None)) 165 setattr(self, "_{}".format('tax_exempt_id'), kwargs.get('tax_exempt_id', None)) 166 167 @property 168 def add_ons(self): 169 """Gets the add_ons of this AccountBillingPlan. # noqa: E501 170 171 Reserved: # noqa: E501 172 173 :return: The add_ons of this AccountBillingPlan. # noqa: E501 174 :rtype: list[AddOn] 175 """ 176 return self._add_ons 177 178 @add_ons.setter 179 def add_ons(self, add_ons): 180 """Sets the add_ons of this AccountBillingPlan. 181 182 Reserved: # noqa: E501 183 184 :param add_ons: The add_ons of this AccountBillingPlan. # noqa: E501 185 :type: list[AddOn] 186 """ 187 188 self._add_ons = add_ons 189 190 @property 191 def app_store_receipt_expiration_date(self): 192 """Gets the app_store_receipt_expiration_date of this AccountBillingPlan. # noqa: E501 193 194 # noqa: E501 195 196 :return: The app_store_receipt_expiration_date of this AccountBillingPlan. # noqa: E501 197 :rtype: str 198 """ 199 return self._app_store_receipt_expiration_date 200 201 @app_store_receipt_expiration_date.setter 202 def app_store_receipt_expiration_date(self, app_store_receipt_expiration_date): 203 """Sets the app_store_receipt_expiration_date of this AccountBillingPlan. 204 205 # noqa: E501 206 207 :param app_store_receipt_expiration_date: The app_store_receipt_expiration_date of this AccountBillingPlan. # noqa: E501 208 :type: str 209 """ 210 211 self._app_store_receipt_expiration_date = app_store_receipt_expiration_date 212 213 @property 214 def app_store_receipt_purchase_date(self): 215 """Gets the app_store_receipt_purchase_date of this AccountBillingPlan. # noqa: E501 216 217 # noqa: E501 218 219 :return: The app_store_receipt_purchase_date of this AccountBillingPlan. # noqa: E501 220 :rtype: str 221 """ 222 return self._app_store_receipt_purchase_date 223 224 @app_store_receipt_purchase_date.setter 225 def app_store_receipt_purchase_date(self, app_store_receipt_purchase_date): 226 """Sets the app_store_receipt_purchase_date of this AccountBillingPlan. 227 228 # noqa: E501 229 230 :param app_store_receipt_purchase_date: The app_store_receipt_purchase_date of this AccountBillingPlan. # noqa: E501 231 :type: str 232 """ 233 234 self._app_store_receipt_purchase_date = app_store_receipt_purchase_date 235 236 @property 237 def can_cancel_renewal(self): 238 """Gets the can_cancel_renewal of this AccountBillingPlan. # noqa: E501 239 240 Reserved: TBD # noqa: E501 241 242 :return: The can_cancel_renewal of this AccountBillingPlan. # noqa: E501 243 :rtype: str 244 """ 245 return self._can_cancel_renewal 246 247 @can_cancel_renewal.setter 248 def can_cancel_renewal(self, can_cancel_renewal): 249 """Sets the can_cancel_renewal of this AccountBillingPlan. 250 251 Reserved: TBD # noqa: E501 252 253 :param can_cancel_renewal: The can_cancel_renewal of this AccountBillingPlan. # noqa: E501 254 :type: str 255 """ 256 257 self._can_cancel_renewal = can_cancel_renewal 258 259 @property 260 def can_upgrade(self): 261 """Gets the can_upgrade of this AccountBillingPlan. # noqa: E501 262 263 When set to **true**, specifies that you can upgrade the account through the API. # noqa: E501 264 265 :return: The can_upgrade of this AccountBillingPlan. # noqa: E501 266 :rtype: str 267 """ 268 return self._can_upgrade 269 270 @can_upgrade.setter 271 def can_upgrade(self, can_upgrade): 272 """Sets the can_upgrade of this AccountBillingPlan. 273 274 When set to **true**, specifies that you can upgrade the account through the API. # noqa: E501 275 276 :param can_upgrade: The can_upgrade of this AccountBillingPlan. # noqa: E501 277 :type: str 278 """ 279 280 self._can_upgrade = can_upgrade 281 282 @property 283 def currency_code(self): 284 """Gets the currency_code of this AccountBillingPlan. # noqa: E501 285 286 Specifies the ISO currency code for the account. # noqa: E501 287 288 :return: The currency_code of this AccountBillingPlan. # noqa: E501 289 :rtype: str 290 """ 291 return self._currency_code 292 293 @currency_code.setter 294 def currency_code(self, currency_code): 295 """Sets the currency_code of this AccountBillingPlan. 296 297 Specifies the ISO currency code for the account. # noqa: E501 298 299 :param currency_code: The currency_code of this AccountBillingPlan. # noqa: E501 300 :type: str 301 """ 302 303 self._currency_code = currency_code 304 305 @property 306 def downgrade_plan_information(self): 307 """Gets the downgrade_plan_information of this AccountBillingPlan. # noqa: E501 308 309 # noqa: E501 310 311 :return: The downgrade_plan_information of this AccountBillingPlan. # noqa: E501 312 :rtype: DowngradePlanUpdateResponse 313 """ 314 return self._downgrade_plan_information 315 316 @downgrade_plan_information.setter 317 def downgrade_plan_information(self, downgrade_plan_information): 318 """Sets the downgrade_plan_information of this AccountBillingPlan. 319 320 # noqa: E501 321 322 :param downgrade_plan_information: The downgrade_plan_information of this AccountBillingPlan. # noqa: E501 323 :type: DowngradePlanUpdateResponse 324 """ 325 326 self._downgrade_plan_information = downgrade_plan_information 327 328 @property 329 def enable_support(self): 330 """Gets the enable_support of this AccountBillingPlan. # noqa: E501 331 332 When set to **true**, then customer support is provided as part of the account plan. # noqa: E501 333 334 :return: The enable_support of this AccountBillingPlan. # noqa: E501 335 :rtype: str 336 """ 337 return self._enable_support 338 339 @enable_support.setter 340 def enable_support(self, enable_support): 341 """Sets the enable_support of this AccountBillingPlan. 342 343 When set to **true**, then customer support is provided as part of the account plan. # noqa: E501 344 345 :param enable_support: The enable_support of this AccountBillingPlan. # noqa: E501 346 :type: str 347 """ 348 349 self._enable_support = enable_support 350 351 @property 352 def included_seats(self): 353 """Gets the included_seats of this AccountBillingPlan. # noqa: E501 354 355 The number of seats (users) included. # noqa: E501 356 357 :return: The included_seats of this AccountBillingPlan. # noqa: E501 358 :rtype: str 359 """ 360 return self._included_seats 361 362 @included_seats.setter 363 def included_seats(self, included_seats): 364 """Sets the included_seats of this AccountBillingPlan. 365 366 The number of seats (users) included. # noqa: E501 367 368 :param included_seats: The included_seats of this AccountBillingPlan. # noqa: E501 369 :type: str 370 """ 371 372 self._included_seats = included_seats 373 374 @property 375 def incremental_seats(self): 376 """Gets the incremental_seats of this AccountBillingPlan. # noqa: E501 377 378 Reserved: TBD # noqa: E501 379 380 :return: The incremental_seats of this AccountBillingPlan. # noqa: E501 381 :rtype: str 382 """ 383 return self._incremental_seats 384 385 @incremental_seats.setter 386 def incremental_seats(self, incremental_seats): 387 """Sets the incremental_seats of this AccountBillingPlan. 388 389 Reserved: TBD # noqa: E501 390 391 :param incremental_seats: The incremental_seats of this AccountBillingPlan. # noqa: E501 392 :type: str 393 """ 394 395 self._incremental_seats = incremental_seats 396 397 @property 398 def is_downgrade(self): 399 """Gets the is_downgrade of this AccountBillingPlan. # noqa: E501 400 401 # noqa: E501 402 403 :return: The is_downgrade of this AccountBillingPlan. # noqa: E501 404 :rtype: str 405 """ 406 return self._is_downgrade 407 408 @is_downgrade.setter 409 def is_downgrade(self, is_downgrade): 410 """Sets the is_downgrade of this AccountBillingPlan. 411 412 # noqa: E501 413 414 :param is_downgrade: The is_downgrade of this AccountBillingPlan. # noqa: E501 415 :type: str 416 """ 417 418 self._is_downgrade = is_downgrade 419 420 @property 421 def notification_type(self): 422 """Gets the notification_type of this AccountBillingPlan. # noqa: E501 423 424 # noqa: E501 425 426 :return: The notification_type of this AccountBillingPlan. # noqa: E501 427 :rtype: str 428 """ 429 return self._notification_type 430 431 @notification_type.setter 432 def notification_type(self, notification_type): 433 """Sets the notification_type of this AccountBillingPlan. 434 435 # noqa: E501 436 437 :param notification_type: The notification_type of this AccountBillingPlan. # noqa: E501 438 :type: str 439 """ 440 441 self._notification_type = notification_type 442 443 @property 444 def other_discount_percent(self): 445 """Gets the other_discount_percent of this AccountBillingPlan. # noqa: E501 446 447 Any other percentage discount for the plan. # noqa: E501 448 449 :return: The other_discount_percent of this AccountBillingPlan. # noqa: E501 450 :rtype: str 451 """ 452 return self._other_discount_percent 453 454 @other_discount_percent.setter 455 def other_discount_percent(self, other_discount_percent): 456 """Sets the other_discount_percent of this AccountBillingPlan. 457 458 Any other percentage discount for the plan. # noqa: E501 459 460 :param other_discount_percent: The other_discount_percent of this AccountBillingPlan. # noqa: E501 461 :type: str 462 """ 463 464 self._other_discount_percent = other_discount_percent 465 466 @property 467 def payment_cycle(self): 468 """Gets the payment_cycle of this AccountBillingPlan. # noqa: E501 469 470 # noqa: E501 471 472 :return: The payment_cycle of this AccountBillingPlan. # noqa: E501 473 :rtype: str 474 """ 475 return self._payment_cycle 476 477 @payment_cycle.setter 478 def payment_cycle(self, payment_cycle): 479 """Sets the payment_cycle of this AccountBillingPlan. 480 481 # noqa: E501 482 483 :param payment_cycle: The payment_cycle of this AccountBillingPlan. # noqa: E501 484 :type: str 485 """ 486 487 self._payment_cycle = payment_cycle 488 489 @property 490 def payment_method(self): 491 """Gets the payment_method of this AccountBillingPlan. # noqa: E501 492 493 The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. # noqa: E501 494 495 :return: The payment_method of this AccountBillingPlan. # noqa: E501 496 :rtype: str 497 """ 498 return self._payment_method 499 500 @payment_method.setter 501 def payment_method(self, payment_method): 502 """Sets the payment_method of this AccountBillingPlan. 503 504 The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. # noqa: E501 505 506 :param payment_method: The payment_method of this AccountBillingPlan. # noqa: E501 507 :type: str 508 """ 509 510 self._payment_method = payment_method 511 512 @property 513 def per_seat_price(self): 514 """Gets the per_seat_price of this AccountBillingPlan. # noqa: E501 515 516 # noqa: E501 517 518 :return: The per_seat_price of this AccountBillingPlan. # noqa: E501 519 :rtype: str 520 """ 521 return self._per_seat_price 522 523 @per_seat_price.setter 524 def per_seat_price(self, per_seat_price): 525 """Sets the per_seat_price of this AccountBillingPlan. 526 527 # noqa: E501 528 529 :param per_seat_price: The per_seat_price of this AccountBillingPlan. # noqa: E501 530 :type: str 531 """ 532 533 self._per_seat_price = per_seat_price 534 535 @property 536 def plan_classification(self): 537 """Gets the plan_classification of this AccountBillingPlan. # noqa: E501 538 539 Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. # noqa: E501 540 541 :return: The plan_classification of this AccountBillingPlan. # noqa: E501 542 :rtype: str 543 """ 544 return self._plan_classification 545 546 @plan_classification.setter 547 def plan_classification(self, plan_classification): 548 """Sets the plan_classification of this AccountBillingPlan. 549 550 Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. # noqa: E501 551 552 :param plan_classification: The plan_classification of this AccountBillingPlan. # noqa: E501 553 :type: str 554 """ 555 556 self._plan_classification = plan_classification 557 558 @property 559 def plan_feature_sets(self): 560 """Gets the plan_feature_sets of this AccountBillingPlan. # noqa: E501 561 562 A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). # noqa: E501 563 564 :return: The plan_feature_sets of this AccountBillingPlan. # noqa: E501 565 :rtype: list[FeatureSet] 566 """ 567 return self._plan_feature_sets 568 569 @plan_feature_sets.setter 570 def plan_feature_sets(self, plan_feature_sets): 571 """Sets the plan_feature_sets of this AccountBillingPlan. 572 573 A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). # noqa: E501 574 575 :param plan_feature_sets: The plan_feature_sets of this AccountBillingPlan. # noqa: E501 576 :type: list[FeatureSet] 577 """ 578 579 self._plan_feature_sets = plan_feature_sets 580 581 @property 582 def plan_id(self): 583 """Gets the plan_id of this AccountBillingPlan. # noqa: E501 584 585 # noqa: E501 586 587 :return: The plan_id of this AccountBillingPlan. # noqa: E501 588 :rtype: str 589 """ 590 return self._plan_id 591 592 @plan_id.setter 593 def plan_id(self, plan_id): 594 """Sets the plan_id of this AccountBillingPlan. 595 596 # noqa: E501 597 598 :param plan_id: The plan_id of this AccountBillingPlan. # noqa: E501 599 :type: str 600 """ 601 602 self._plan_id = plan_id 603 604 @property 605 def plan_name(self): 606 """Gets the plan_name of this AccountBillingPlan. # noqa: E501 607 608 The name of the Billing Plan. # noqa: E501 609 610 :return: The plan_name of this AccountBillingPlan. # noqa: E501 611 :rtype: str 612 """ 613 return self._plan_name 614 615 @plan_name.setter 616 def plan_name(self, plan_name): 617 """Sets the plan_name of this AccountBillingPlan. 618 619 The name of the Billing Plan. # noqa: E501 620 621 :param plan_name: The plan_name of this AccountBillingPlan. # noqa: E501 622 :type: str 623 """ 624 625 self._plan_name = plan_name 626 627 @property 628 def plan_start_date(self): 629 """Gets the plan_start_date of this AccountBillingPlan. # noqa: E501 630 631 # noqa: E501 632 633 :return: The plan_start_date of this AccountBillingPlan. # noqa: E501 634 :rtype: str 635 """ 636 return self._plan_start_date 637 638 @plan_start_date.setter 639 def plan_start_date(self, plan_start_date): 640 """Sets the plan_start_date of this AccountBillingPlan. 641 642 # noqa: E501 643 644 :param plan_start_date: The plan_start_date of this AccountBillingPlan. # noqa: E501 645 :type: str 646 """ 647 648 self._plan_start_date = plan_start_date 649 650 @property 651 def product_id(self): 652 """Gets the product_id of this AccountBillingPlan. # noqa: E501 653 654 # noqa: E501 655 656 :return: The product_id of this AccountBillingPlan. # noqa: E501 657 :rtype: str 658 """ 659 return self._product_id 660 661 @product_id.setter 662 def product_id(self, product_id): 663 """Sets the product_id of this AccountBillingPlan. 664 665 # noqa: E501 666 667 :param product_id: The product_id of this AccountBillingPlan. # noqa: E501 668 :type: str 669 """ 670 671 self._product_id = product_id 672 673 @property 674 def renewal_date(self): 675 """Gets the renewal_date of this AccountBillingPlan. # noqa: E501 676 677 # noqa: E501 678 679 :return: The renewal_date of this AccountBillingPlan. # noqa: E501 680 :rtype: str 681 """ 682 return self._renewal_date 683 684 @renewal_date.setter 685 def renewal_date(self, renewal_date): 686 """Sets the renewal_date of this AccountBillingPlan. 687 688 # noqa: E501 689 690 :param renewal_date: The renewal_date of this AccountBillingPlan. # noqa: E501 691 :type: str 692 """ 693 694 self._renewal_date = renewal_date 695 696 @property 697 def renewal_status(self): 698 """Gets the renewal_status of this AccountBillingPlan. # noqa: E501 699 700 The renewal status for the account. The acceptable values are: * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate. # noqa: E501 701 702 :return: The renewal_status of this AccountBillingPlan. # noqa: E501 703 :rtype: str 704 """ 705 return self._renewal_status 706 707 @renewal_status.setter 708 def renewal_status(self, renewal_status): 709 """Sets the renewal_status of this AccountBillingPlan. 710 711 The renewal status for the account. The acceptable values are: * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate. # noqa: E501 712 713 :param renewal_status: The renewal_status of this AccountBillingPlan. # noqa: E501 714 :type: str 715 """ 716 717 self._renewal_status = renewal_status 718 719 @property 720 def seat_discounts(self): 721 """Gets the seat_discounts of this AccountBillingPlan. # noqa: E501 722 723 A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. # noqa: E501 724 725 :return: The seat_discounts of this AccountBillingPlan. # noqa: E501 726 :rtype: list[SeatDiscount] 727 """ 728 return self._seat_discounts 729 730 @seat_discounts.setter 731 def seat_discounts(self, seat_discounts): 732 """Sets the seat_discounts of this AccountBillingPlan. 733 734 A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. # noqa: E501 735 736 :param seat_discounts: The seat_discounts of this AccountBillingPlan. # noqa: E501 737 :type: list[SeatDiscount] 738 """ 739 740 self._seat_discounts = seat_discounts 741 742 @property 743 def subscription_start_date(self): 744 """Gets the subscription_start_date of this AccountBillingPlan. # noqa: E501 745 746 # noqa: E501 747 748 :return: The subscription_start_date of this AccountBillingPlan. # noqa: E501 749 :rtype: str 750 """ 751 return self._subscription_start_date 752 753 @subscription_start_date.setter 754 def subscription_start_date(self, subscription_start_date): 755 """Sets the subscription_start_date of this AccountBillingPlan. 756 757 # noqa: E501 758 759 :param subscription_start_date: The subscription_start_date of this AccountBillingPlan. # noqa: E501 760 :type: str 761 """ 762 763 self._subscription_start_date = subscription_start_date 764 765 @property 766 def support_incident_fee(self): 767 """Gets the support_incident_fee of this AccountBillingPlan. # noqa: E501 768 769 The support incident fee charged for each support incident. # noqa: E501 770 771 :return: The support_incident_fee of this AccountBillingPlan. # noqa: E501 772 :rtype: str 773 """ 774 return self._support_incident_fee 775 776 @support_incident_fee.setter 777 def support_incident_fee(self, support_incident_fee): 778 """Sets the support_incident_fee of this AccountBillingPlan. 779 780 The support incident fee charged for each support incident. # noqa: E501 781 782 :param support_incident_fee: The support_incident_fee of this AccountBillingPlan. # noqa: E501 783 :type: str 784 """ 785 786 self._support_incident_fee = support_incident_fee 787 788 @property 789 def support_plan_fee(self): 790 """Gets the support_plan_fee of this AccountBillingPlan. # noqa: E501 791 792 The support plan fee charged for this plan. # noqa: E501 793 794 :return: The support_plan_fee of this AccountBillingPlan. # noqa: E501 795 :rtype: str 796 """ 797 return self._support_plan_fee 798 799 @support_plan_fee.setter 800 def support_plan_fee(self, support_plan_fee): 801 """Sets the support_plan_fee of this AccountBillingPlan. 802 803 The support plan fee charged for this plan. # noqa: E501 804 805 :param support_plan_fee: The support_plan_fee of this AccountBillingPlan. # noqa: E501 806 :type: str 807 """ 808 809 self._support_plan_fee = support_plan_fee 810 811 @property 812 def tax_exempt_id(self): 813 """Gets the tax_exempt_id of this AccountBillingPlan. # noqa: E501 814 815 # noqa: E501 816 817 :return: The tax_exempt_id of this AccountBillingPlan. # noqa: E501 818 :rtype: str 819 """ 820 return self._tax_exempt_id 821 822 @tax_exempt_id.setter 823 def tax_exempt_id(self, tax_exempt_id): 824 """Sets the tax_exempt_id of this AccountBillingPlan. 825 826 # noqa: E501 827 828 :param tax_exempt_id: The tax_exempt_id of this AccountBillingPlan. # noqa: E501 829 :type: str 830 """ 831 832 self._tax_exempt_id = tax_exempt_id 833 834 def to_dict(self): 835 """Returns the model properties as a dict""" 836 result = {} 837 838 for attr, _ in six.iteritems(self.swagger_types): 839 value = getattr(self, attr) 840 if isinstance(value, list): 841 result[attr] = list(map( 842 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 843 value 844 )) 845 elif hasattr(value, "to_dict"): 846 result[attr] = value.to_dict() 847 elif isinstance(value, dict): 848 result[attr] = dict(map( 849 lambda item: (item[0], item[1].to_dict()) 850 if hasattr(item[1], "to_dict") else item, 851 value.items() 852 )) 853 else: 854 result[attr] = value 855 if issubclass(AccountBillingPlan, dict): 856 for key, value in self.items(): 857 result[key] = value 858 859 return result 860 861 def to_str(self): 862 """Returns the string representation of the model""" 863 return pprint.pformat(self.to_dict()) 864 865 def __repr__(self): 866 """For `print` and `pprint`""" 867 return self.to_str() 868 869 def __eq__(self, other): 870 """Returns true if both objects are equal""" 871 if not isinstance(other, AccountBillingPlan): 872 return False 873 874 return self.to_dict() == other.to_dict() 875 876 def __ne__(self, other): 877 """Returns true if both objects are not equal""" 878 if not isinstance(other, AccountBillingPlan): 879 return True 880 881 return self.to_dict() != other.to_dict()
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
100 def __init__(self, _configuration=None, **kwargs): # noqa: E501 101 """AccountBillingPlan - a model defined in Swagger""" # noqa: E501 102 if _configuration is None: 103 _configuration = Configuration() 104 self._configuration = _configuration 105 106 self._add_ons = None 107 self._app_store_receipt_expiration_date = None 108 self._app_store_receipt_purchase_date = None 109 self._can_cancel_renewal = None 110 self._can_upgrade = None 111 self._currency_code = None 112 self._downgrade_plan_information = None 113 self._enable_support = None 114 self._included_seats = None 115 self._incremental_seats = None 116 self._is_downgrade = None 117 self._notification_type = None 118 self._other_discount_percent = None 119 self._payment_cycle = None 120 self._payment_method = None 121 self._per_seat_price = None 122 self._plan_classification = None 123 self._plan_feature_sets = None 124 self._plan_id = None 125 self._plan_name = None 126 self._plan_start_date = None 127 self._product_id = None 128 self._renewal_date = None 129 self._renewal_status = None 130 self._seat_discounts = None 131 self._subscription_start_date = None 132 self._support_incident_fee = None 133 self._support_plan_fee = None 134 self._tax_exempt_id = None 135 self.discriminator = None 136 137 setattr(self, "_{}".format('add_ons'), kwargs.get('add_ons', None)) 138 setattr(self, "_{}".format('app_store_receipt_expiration_date'), kwargs.get('app_store_receipt_expiration_date', None)) 139 setattr(self, "_{}".format('app_store_receipt_purchase_date'), kwargs.get('app_store_receipt_purchase_date', None)) 140 setattr(self, "_{}".format('can_cancel_renewal'), kwargs.get('can_cancel_renewal', None)) 141 setattr(self, "_{}".format('can_upgrade'), kwargs.get('can_upgrade', None)) 142 setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None)) 143 setattr(self, "_{}".format('downgrade_plan_information'), kwargs.get('downgrade_plan_information', None)) 144 setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None)) 145 setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None)) 146 setattr(self, "_{}".format('incremental_seats'), kwargs.get('incremental_seats', None)) 147 setattr(self, "_{}".format('is_downgrade'), kwargs.get('is_downgrade', None)) 148 setattr(self, "_{}".format('notification_type'), kwargs.get('notification_type', None)) 149 setattr(self, "_{}".format('other_discount_percent'), kwargs.get('other_discount_percent', None)) 150 setattr(self, "_{}".format('payment_cycle'), kwargs.get('payment_cycle', None)) 151 setattr(self, "_{}".format('payment_method'), kwargs.get('payment_method', None)) 152 setattr(self, "_{}".format('per_seat_price'), kwargs.get('per_seat_price', None)) 153 setattr(self, "_{}".format('plan_classification'), kwargs.get('plan_classification', None)) 154 setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None)) 155 setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None)) 156 setattr(self, "_{}".format('plan_name'), kwargs.get('plan_name', None)) 157 setattr(self, "_{}".format('plan_start_date'), kwargs.get('plan_start_date', None)) 158 setattr(self, "_{}".format('product_id'), kwargs.get('product_id', None)) 159 setattr(self, "_{}".format('renewal_date'), kwargs.get('renewal_date', None)) 160 setattr(self, "_{}".format('renewal_status'), kwargs.get('renewal_status', None)) 161 setattr(self, "_{}".format('seat_discounts'), kwargs.get('seat_discounts', None)) 162 setattr(self, "_{}".format('subscription_start_date'), kwargs.get('subscription_start_date', None)) 163 setattr(self, "_{}".format('support_incident_fee'), kwargs.get('support_incident_fee', None)) 164 setattr(self, "_{}".format('support_plan_fee'), kwargs.get('support_plan_fee', None)) 165 setattr(self, "_{}".format('tax_exempt_id'), kwargs.get('tax_exempt_id', None))
AccountBillingPlan - a model defined in Swagger
Gets the add_ons of this AccountBillingPlan. # noqa: E501
Reserved: # noqa: E501
Returns
The add_ons of this AccountBillingPlan. # noqa: E501
Gets the app_store_receipt_expiration_date of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The app_store_receipt_expiration_date of this AccountBillingPlan. # noqa: E501
Gets the app_store_receipt_purchase_date of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The app_store_receipt_purchase_date of this AccountBillingPlan. # noqa: E501
Gets the can_cancel_renewal of this AccountBillingPlan. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The can_cancel_renewal of this AccountBillingPlan. # noqa: E501
Gets the can_upgrade of this AccountBillingPlan. # noqa: E501
When set to true, specifies that you can upgrade the account through the API. # noqa: E501
Returns
The can_upgrade of this AccountBillingPlan. # noqa: E501
Gets the currency_code of this AccountBillingPlan. # noqa: E501
Specifies the ISO currency code for the account. # noqa: E501
Returns
The currency_code of this AccountBillingPlan. # noqa: E501
Gets the downgrade_plan_information of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The downgrade_plan_information of this AccountBillingPlan. # noqa: E501
Gets the enable_support of this AccountBillingPlan. # noqa: E501
When set to true, then customer support is provided as part of the account plan. # noqa: E501
Returns
The enable_support of this AccountBillingPlan. # noqa: E501
Gets the included_seats of this AccountBillingPlan. # noqa: E501
The number of seats (users) included. # noqa: E501
Returns
The included_seats of this AccountBillingPlan. # noqa: E501
Gets the incremental_seats of this AccountBillingPlan. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The incremental_seats of this AccountBillingPlan. # noqa: E501
Gets the is_downgrade of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The is_downgrade of this AccountBillingPlan. # noqa: E501
Gets the notification_type of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The notification_type of this AccountBillingPlan. # noqa: E501
Gets the other_discount_percent of this AccountBillingPlan. # noqa: E501
Any other percentage discount for the plan. # noqa: E501
Returns
The other_discount_percent of this AccountBillingPlan. # noqa: E501
Gets the payment_cycle of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The payment_cycle of this AccountBillingPlan. # noqa: E501
Gets the payment_method of this AccountBillingPlan. # noqa: E501
The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. # noqa: E501
Returns
The payment_method of this AccountBillingPlan. # noqa: E501
Gets the per_seat_price of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The per_seat_price of this AccountBillingPlan. # noqa: E501
Gets the plan_classification of this AccountBillingPlan. # noqa: E501
Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. # noqa: E501
Returns
The plan_classification of this AccountBillingPlan. # noqa: E501
Gets the plan_feature_sets of this AccountBillingPlan. # noqa: E501
A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). # noqa: E501
Returns
The plan_feature_sets of this AccountBillingPlan. # noqa: E501
Gets the plan_id of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The plan_id of this AccountBillingPlan. # noqa: E501
Gets the plan_name of this AccountBillingPlan. # noqa: E501
The name of the Billing Plan. # noqa: E501
Returns
The plan_name of this AccountBillingPlan. # noqa: E501
Gets the plan_start_date of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The plan_start_date of this AccountBillingPlan. # noqa: E501
Gets the product_id of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The product_id of this AccountBillingPlan. # noqa: E501
Gets the renewal_date of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The renewal_date of this AccountBillingPlan. # noqa: E501
Gets the renewal_status of this AccountBillingPlan. # noqa: E501
The renewal status for the account. The acceptable values are: * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate. # noqa: E501
Returns
The renewal_status of this AccountBillingPlan. # noqa: E501
Gets the seat_discounts of this AccountBillingPlan. # noqa: E501
A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. # noqa: E501
Returns
The seat_discounts of this AccountBillingPlan. # noqa: E501
Gets the subscription_start_date of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The subscription_start_date of this AccountBillingPlan. # noqa: E501
Gets the support_incident_fee of this AccountBillingPlan. # noqa: E501
The support incident fee charged for each support incident. # noqa: E501
Returns
The support_incident_fee of this AccountBillingPlan. # noqa: E501
Gets the support_plan_fee of this AccountBillingPlan. # noqa: E501
The support plan fee charged for this plan. # noqa: E501
Returns
The support_plan_fee of this AccountBillingPlan. # noqa: E501
Gets the tax_exempt_id of this AccountBillingPlan. # noqa: E501
# noqa: E501
Returns
The tax_exempt_id of this AccountBillingPlan. # noqa: E501
834 def to_dict(self): 835 """Returns the model properties as a dict""" 836 result = {} 837 838 for attr, _ in six.iteritems(self.swagger_types): 839 value = getattr(self, attr) 840 if isinstance(value, list): 841 result[attr] = list(map( 842 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 843 value 844 )) 845 elif hasattr(value, "to_dict"): 846 result[attr] = value.to_dict() 847 elif isinstance(value, dict): 848 result[attr] = dict(map( 849 lambda item: (item[0], item[1].to_dict()) 850 if hasattr(item[1], "to_dict") else item, 851 value.items() 852 )) 853 else: 854 result[attr] = value 855 if issubclass(AccountBillingPlan, dict): 856 for key, value in self.items(): 857 result[key] = value 858 859 return result
Returns the model properties as a dict